{ "item": [ { "id": "2cec9c98-3951-4f23-9634-7a0e5a6558ff", "name": "alerts", "item": [ { "id": "d16fbe64-f9d5-4ade-b212-ef16c6b80d2b", "name": "Creates a new alert", "request": { "name": "Creates a new alert", "description": { "content": "Creates a new alert in CDC.
\nThis operation is idempotent: if the client provides a sourceId which already exists in CDC, then the operation should succeed with UPSERT semantics.br/>\n**NOTE:** The maximum request size is 2 MB.\n", "type": "text/plain" }, "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"severity\": \"\",\n \"sourceUrl\": \"\",\n \"raw\": \"\",\n \"classification\": \"\",\n \"observables\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"company\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"\",\n \"\"\n ],\n \"detectionRule\": \"\",\n \"alertType\": \"\",\n \"threatType\": \"\",\n \"threatActors\": [\n \"\",\n \"\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"\"\n}" } }, "response": [ { "id": "d24fd53a-4fc0-4da5-9a8c-9492afb3bdce", "name": "The alert has been created", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"sunt do\",\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"status\": \"In Incident\",\n \"created\": \"2021-06-09T02:38:04.417Z\",\n \"modified\": \"1956-07-21T00:03:17.584Z\",\n \"detected\": \"1967-08-11T05:23:55.959Z\",\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"observableTags\": [\n \"LHqu*72no\",\n \"vF\"\n ],\n \"killChain\": [\n \"Weap\",\n \"Deli\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"score\": 33.2,\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"classification\": \"Authentication\",\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"threatType\": \"Phishing\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c72fa93-9ab8-4c7d-8646-6c047ffbd8ae", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ae2fcdf-d907-4fea-8955-3979cae7af91", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b00baced-8dc9-4483-b112-f534822ba35a", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a3994c14-ebc2-49e1-813b-66d2297d6d96", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f5e0599-91a5-4b5e-956b-886bd1b41d67", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7dd8cd13-74a7-4b77-89fc-b212a7bd925d", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9be53590-b94f-436e-8597-1ad2cd1ae1c8", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f272ccb5-3de7-4c5f-b1e5-08e253c45f96", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "502101dd-2c7d-4083-bced-b4fb250d1eb0", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceId\": \"345ffe9a\",\n \"name\": \"Email messages containing malware removed after delivery\",\n \"description\": \"message containing malware are delivered to mailboxes in your organization. Office 365 removed the infected messages from Exchange Online mailboxes.\",\n \"severity\": \"High\",\n \"sourceUrl\": \"http://10.0.0.90/MySIEM/api/alerts/345ffe9a\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"classification\": \"Authentication\",\n \"observables\": [\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n },\n {\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"extraProperties\": \"\",\n \"relatedExtraProperties\": \"\"\n }\n ],\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"company\": \"ACME\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"\",\n \"\"\n ],\n \"ctiSourceUrls\": [\n \"\",\n \"\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\",\n \"killChain\": [\n \"\",\n \"\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"detected\": \"\",\n \"source\": \"QRadar\"\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "2fd33849-929c-40c3-afc4-6eaa94e26400", "name": "Queries alerts based on filters provided by the client.\nFor synchronization purposes, the `updatedAfter` filter option should be used.\n", "request": { "name": "Queries alerts based on filters provided by the client.\nFor synchronization purposes, the `updatedAfter` filter option should be used.\n", "description": {}, "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "Include only those which were updated before the specified timestamp (exclusive)", "key": "updatedBefore", "value": "" }, { "description": "Include only those which were updated after or at the specified timestamp (inclusive)", "key": "updatedAfter", "value": "" }, { "description": "Include only those which were detected before the specified timestamp (exclusive)", "key": "detectedBefore", "value": "" }, { "description": "Include only those which were detected after the specified timestamp (inclusive)", "key": "detectedAfter", "value": "" }, { "description": "Filter alerts by status", "key": "status", "value": "" }, { "description": "Filter alerts by status", "key": "status", "value": "" }, { "description": "Filter alerts by severity", "key": "severity", "value": "" }, { "description": "Filter alerts by severity", "key": "severity", "value": "" }, { "description": "Filter alerts by company", "key": "company", "value": "" }, { "description": "Filters alerts by their source system.\nOften combined with the `sourceId` parameter, in order to find an alert by its external ID.`\n", "key": "source", "value": "" }, { "description": "When combined with the `source` parameter - finds an alert by its source ID (the ID as defined by the SIEM).\nIf `sourceId` is specified but `source` is not specified, the query will fail and return 400 (Bad Request). \n", "key": "sourceId", "value": "" }, { "description": "Filters alerts by their use case.", "key": "useCase", "value": "" }, { "description": "Filters alerts by observable: only alerts linked to the specified observable will be returned. \n\nThis parameter specifies the observable's type, and it must be combined with the `observableValue` parameter.\n", "key": "observableType", "value": "" }, { "description": "Filters alerts by observable: only alerts linked to the specified observable will be returned. \n\nThis parameter specifies the observable's value, and it must be combined with the `observableType` parameter.\n", "key": "observableValue", "value": "" }, { "description": "Filter alerts by their type", "key": "alertType", "value": "" }, { "description": "Filter alerts by their type", "key": "alertType", "value": "" }, { "description": "Filter alerts by threat types", "key": "threatType", "value": "" }, { "description": "Filter alerts by threat types", "key": "threatType", "value": "" }, { "description": "Filters alerts by tags.\n\nNote: if more than one tag is specified, the client must specify the `tagsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "tags", "value": "" }, { "description": "Filters alerts by tags.\n\nNote: if more than one tag is specified, the client must specify the `tagsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "tags", "value": "" }, { "description": "If `tags` contains multiple items, determines the query predicate:\n- `any`: returns results which contain at least one of the specified tags\n- `all`: returns results which contain all of the specified tags\n", "key": "tagsCondition", "value": "" }, { "description": "Filters alerts by observable tags.\n\nNote: if more than one tag is specified, the client must specify the `observableTagsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "observableTags", "value": "" }, { "description": "Filters alerts by observable tags.\n\nNote: if more than one tag is specified, the client must specify the `observableTagsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "observableTags", "value": "" }, { "description": "If `observableTags` contains multiple items, determines the query predicate:\n- `any`: returns results which contain at least one of the specified tags\n- `all`: returns results which contain all of the specified tags\n", "key": "observableTagsCondition", "value": "" }, { "description": "Filters alerts by threat actors.\nNote: if more than one value is specified, the client must specify the `threatActorsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "threatActors", "value": "" }, { "description": "Filters alerts by threat actors.\nNote: if more than one value is specified, the client must specify the `threatActorsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "threatActors", "value": "" }, { "description": "If `threatActors` contains multiple items, determines the query predicate:\n- `any`: returns results which contain at least one of the specified values\n- `all`: returns results which contain all of the specified values\n", "key": "threatActorsCondition", "value": "" }, { "description": "Filters alerts by maleware and tools.\nNote: if more than one value is specified, the client must specify the `malwareToolsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "malwareTools", "value": "" }, { "description": "Filters alerts by maleware and tools.\nNote: if more than one value is specified, the client must specify the `malwareToolsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "malwareTools", "value": "" }, { "description": "If `malwareTools` contains multiple items, determines the query predicate:\n- `any`: returns results which contain at least one of the specified values\n- `all`: returns results which contain all of the specified values\n", "key": "malwareToolsCondition", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "666225a7-8342-4062-a902-5b65463c7c17", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"culpa ut eu ut\",\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"status\": \"In Incident\",\n \"created\": \"1966-02-04T07:37:49.595Z\",\n \"modified\": \"1992-09-28T02:54:00.135Z\",\n \"detected\": \"1961-12-14T17:28:20.045Z\",\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"observableTags\": [\n \"P+A\",\n \"\"\n ],\n \"threatType\": \"Phishing\"\n },\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"cill\",\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"status\": \"In Incident\",\n \"created\": \"1980-06-21T08:14:07.503Z\",\n \"modified\": \"2001-01-26T03:39:54.659Z\",\n \"detected\": \"1979-01-27T13:18:43.162Z\",\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"observableTags\": [\n \"|_urWT\",\n \"mPy*6A:P_|\"\n ],\n \"killChain\": [\n \"Acti\",\n \"Deli\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"score\": 33.2,\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"classification\": \"Authentication\",\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"threatType\": \"Phishing\"\n }\n ],\n \"nextMarker\": \"mollit esse\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa8ada20-2484-4bdf-989f-1aa690af624f", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "221fff4c-7aa5-44e4-aa03-f9f858fb3ed1", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de026f8f-73b8-43a1-ae45-f20aeefed3c6", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1178cc5-b890-4dac-a201-b310bb40d599", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8444c660-6ebb-42f9-b256-be2ded9dd34e", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c7ee7b5-2009-4080-9bff-177d0897c01d", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e681960f-c4f4-4551-8336-139a658a6f0d", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98e1f36c-1a75-43b6-8f55-aeb39ff34e4f", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "273b20c7-f038-42ff-acfb-054cba861178", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "detectedBefore", "value": "" }, { "key": "detectedAfter", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "severity", "value": "" }, { "key": "severity", "value": "" }, { "key": "company", "value": "" }, { "key": "source", "value": "" }, { "key": "sourceId", "value": "" }, { "key": "useCase", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "alertType", "value": "" }, { "key": "alertType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "threatType", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTags", "value": "" }, { "key": "observableTagsCondition", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActors", "value": "" }, { "key": "threatActorsCondition", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareTools", "value": "" }, { "key": "malwareToolsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "e0e5e4b6-2ca4-4d91-8e5c-13da873fa2c9", "name": "{alert Id}", "item": [ { "id": "b93a5e41-a9fa-4d00-8025-96e043f24bad", "name": "Returns a single alert", "request": { "name": "Returns a single alert", "description": {}, "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the alert, as defined by CDC", "type": "any", "value": "", "key": "alertId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "705f3cfd-00ef-4696-a1a1-d34989569408", "name": "success", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"minim ea eu\",\n \"score\": 33.2,\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"created\": \"1952-04-27T22:36:22.315Z\",\n \"modified\": \"1994-04-19T13:31:49.660Z\",\n \"detected\": \"1957-06-28T11:54:06.478Z\",\n \"status\": \"In Incident\",\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"classification\": \"Authentication\",\n \"observableTags\": [\n \"\",\n \"Xvc<7xH\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"killChain\": [\n \"Weap\",\n \"Inst\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"cdcUrl\": \"https://acme.cyberproof.io/home/alerts/alert/5e7c6cf54b832e0018f191ad\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"in Excepteur adipisicing commodo\",\n \"Ut ad nisi\"\n ],\n \"ctiSourceUrls\": [\n \"https://blog.malwarebytes.com/someTopic\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "180e9a72-2b92-4950-9a4c-ed4389869b98", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a91f017f-caf5-43d0-904c-2417eff52b1f", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d298dd76-df11-421c-8ff1-4523b0c8e12e", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6afd316-dacb-497a-84f6-768b68b8605b", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65ec2af8-921a-41cc-9484-2de5a5ea7a33", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ad40d76-ab03-45c1-ace9-59cd912656bd", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ef9ab4e-d442-4985-b86a-5aae3e89ca21", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50f06829-eaa8-49ef-96b5-e8c90096ae57", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6628aa9e-33dc-49e4-9467-5fbc1085e88d", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts", ":alertId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "ffc51628-f22d-40ab-961d-aac8c4ac22e9", "name": "evidence", "item": [ { "id": "aa24d916-0a0a-4d30-8174-8621e1ad4f7f", "name": "Returns information about the evidence associated with this alert.", "request": { "name": "Returns information about the evidence associated with this alert.", "description": {}, "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "Specifies which additional fields to include in the query results:\n- `data`: includes the evidence metadata.\n", "key": "include", "value": "," } ], "variable": [ { "description": "(Required) The unique ID of the alert, as defined by CDC", "type": "any", "value": "", "key": "alertId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "62593a0b-d083-4a17-855e-1349ed49575c", "name": "success", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"5aa4d8fcbdee5a000a911882\",\n \"type\": \"MITRE_ATTACK_ADDED\",\n \"reported\": \"1984-12-19T14:34:25.277Z\",\n \"created\": \"2007-03-30T23:14:08.996Z\",\n \"caption\": \"Severity changed\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"messageId\": \"dolore \",\n \"messageCdcUrl\": \"https://acme.cyberproof.io/home/incidents/5ea71bb363f6c6001707663b/evidence/5ea71bb363f6c6001707254a\",\n \"externalId\": \"345ffe9a\",\n \"data\": {}\n },\n {\n \"id\": \"5aa4d8fcbdee5a000a911882\",\n \"type\": \"MITRE_ATTACK_ADDED\",\n \"reported\": \"1964-01-16T14:12:31.541Z\",\n \"created\": \"1985-10-10T13:47:01.165Z\",\n \"caption\": \"Severity changed\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"messageId\": \"ex eu commodo enim culpa\",\n \"messageCdcUrl\": \"https://acme.cyberproof.io/home/incidents/5ea71bb363f6c6001707663b/evidence/5ea71bb363f6c6001707254a\",\n \"externalId\": \"345ffe9a\",\n \"data\": {}\n }\n ],\n \"nextMarker\": \"pariatur velit aliquip commodo\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98c2ca35-708d-4149-aeb4-74cd4b297218", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e10d427e-f0f4-4cb8-830d-0931bd7b3152", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7604028-700d-4559-abe8-181a922b5df6", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9de94368-22aa-4763-9d87-f7097987f801", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "140de254-0d7d-45d8-bc06-08da5c87c3ba", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b98484c9-ed3e-4091-8900-635a798a17dd", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44892a54-fed4-4b02-9bf2-475bd32ce71a", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5aaa7cac-e0ea-4a9e-a31a-440a738dbbcc", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46f45a0f-5573-452f-9b97-e51b43d35794", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4097cf0-5af4-4336-b276-479a151d0b75", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "ad2bf86a-dcf1-487e-8e11-f41e74aa3b2a", "name": "Creates a new alert evidence", "request": { "name": "Creates a new alert evidence", "description": {}, "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the alert, as defined by CDC", "type": "any", "value": "", "key": "alertId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"\",\n \"messageId\": \"\",\n \"description\": \"\",\n \"externalId\": \"\"\n}" } }, "response": [ { "id": "ba630f79-ac7b-4db8-9717-c7c75793f0b1", "name": "The evidence has been created", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5aa4d8fcbdee5a000a911882\",\n \"type\": \"MITRE_ATTACK_ADDED\",\n \"reported\": \"1954-01-04T06:46:48.002Z\",\n \"created\": \"1971-08-12T12:21:22.328Z\",\n \"caption\": \"Severity changed\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"messageId\": \"consectetur nostrud\",\n \"messageCdcUrl\": \"https://acme.cyberproof.io/home/incidents/5ea71bb363f6c6001707663b/evidence/5ea71bb363f6c6001707254a\",\n \"externalId\": \"345ffe9a\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f57ba922-ec8b-4aa9-9960-77a51508f92d", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd730e18-9775-47a7-9cc8-dd8e3e2e5331", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80bebf70-281c-439b-a884-b9d2424e2526", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d234dc70-6a1f-4329-a5f6-16b807fbf207", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38cbb29f-f35c-41c2-9abf-63e11b149a31", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63f03c02-e749-4e83-8bfc-cc8e40d0e7af", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "189b8339-9e9b-4367-ba61-5522f2c372a2", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c1586cd-93cf-47ae-ac54-1fc25222f5a3", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e7cd12e-73d0-4cc5-a1e3-22f211cd6194", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be564a12-5151-4dbb-8f9e-79a90a0f0bf0", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d682f73b-684b-4bce-9e29-852b825455e3", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "f1d3ea4e-3957-4e6c-bbda-de218e291894", "name": "extended-properties", "item": [ { "id": "1dcab42c-839c-42ae-942e-2fbf3e1391d8", "name": "Query alert extended properties", "request": { "name": "Query alert extended properties", "description": { "content": "with support for filters and pagination. Default limit is 1000 docs per request.", "type": "text/plain" }, "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "List of the internal field name of the custom-field schema", "key": "names", "value": "" }, { "description": "List of the internal field name of the custom-field schema", "key": "names", "value": "" }, { "description": "List of the db`s document identifier", "key": "ids", "value": "" }, { "description": "List of the db`s document identifier", "key": "ids", "value": "" }, { "description": "", "key": "marker", "value": "" } ], "variable": [ { "description": "(Required) ", "type": "any", "value": "", "key": "alertId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "57bdd664-7f06-44ec-8723-92834e54e77d", "name": "Response for query alert extended properties", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"name\": \"sed dolor nostrud consequat anim\",\n \"id\": \"velit sit est\",\n \"createdBy\": \"sit officia\",\n \"updatedBy\": \"laboris ipsum nostrud dolore\",\n \"createdAt\": \"velit cillum officia Duis aliquip\",\n \"updatedAt\": \"proident cillum\",\n \"value\": {}\n },\n {\n \"name\": \"veniam labore Exc\",\n \"id\": \"Excepteur dolor\",\n \"createdBy\": \"officia incidi\",\n \"updatedBy\": \"reprehenderit consectetur dolor\",\n \"createdAt\": \"amet\",\n \"updatedAt\": \"elit consequat Ut nostrud\",\n \"value\": {}\n }\n ],\n \"nextMarker\": \"mollit velit Lorem adipisicing\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7893f508-9574-4f08-9550-5e40f373494b", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e154632-b136-4175-a771-b3e060a42fc4", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "205979b9-ba55-4cf1-8d45-53a63ca8158c", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28970d4e-c293-4260-a5ec-f20879ee75a8", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cdf0301-dea2-410b-9b12-4559af1b5c76", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b722b492-5f9b-4f30-a2e5-02f71be03241", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d125e6a-6b68-4c78-bb44-2e0a08d2e8fb", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c414336c-fef5-4253-af72-ddb8762e07f3", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29055557-19c8-458a-bbe9-8321feccd108", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38634310-d022-46d0-9f91-a515cc35c529", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "d55f0710-efcd-4f1e-ade3-744f38801963", "name": "Set alert extended properties", "request": { "name": "Set alert extended properties", "description": { "content": "Set alert extended properties", "type": "text/plain" }, "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) ", "type": "any", "value": "", "key": "alertId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "response": [ { "id": "953d2dbe-95eb-4f84-9d30-2d57b4bc71de", "name": "Response for create alert extended properties", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"name\": \"magna deserunt aliqua ea\",\n \"id\": \"labore enim magna\",\n \"createdBy\": \"anim do \",\n \"updatedBy\": \"consectetur sint\",\n \"createdAt\": \"pariatur amet\",\n \"updatedAt\": \"et Lorem officia mollit cillum\",\n \"value\": {}\n },\n {\n \"name\": \"do\",\n \"id\": \"volupta\",\n \"createdBy\": \"sit anim\",\n \"updatedBy\": \"dolor velit o\",\n \"createdAt\": \"minim exercitation\",\n \"updatedAt\": \"voluptate\",\n \"value\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b20a02da-6e73-4e71-8fb8-3c15d46256ff", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e732fdf3-e3df-4c96-a9f0-c5b14a0aead8", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb45495f-9524-4f9b-b9e6-70a3152808d4", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4f62968-0da8-4c0a-838d-2f161142b2b6", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4889fb8d-f745-4a08-a5dd-af17891418d9", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5bc8da82-481e-421d-bdd6-434aadb47551", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bde82d01-d7f1-42de-8fcb-e6c747762e0b", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92190fb8-580e-4d16-a038-65c717fe3df9", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d026c4d-30a4-4842-827d-6c9f293cc46a", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a45870f-20e5-473b-ac88-239ee5b22a87", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "alerts", ":alertId", "extended-properties" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "alertId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "52a99b8d-a108-44a6-ac51-27cfda1080b1", "name": "incidents", "item": [ { "id": "f4f7f003-bf75-4222-bbd3-145a0d5568ad", "name": "Queries incidents based on filters provided by the client.\nFor synchronization purposes, the `updatedAfter` filter option should be used.\n", "request": { "name": "Queries incidents based on filters provided by the client.\nFor synchronization purposes, the `updatedAfter` filter option should be used.\n", "description": {}, "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "Filters according to the specified external ID. Used in conjuction with the externalSystem parameter. \nIf specified, then `externalSystem` MUST be specified as well. \n", "key": "externalId", "value": "" }, { "description": "Identifies the external system to which the filter refers. \nUsed in conjuction with the externalId parameter:\n- If `externalId` is also specified, the filter will return only items which have the specified `externalId` at the specified `externalSystem`.\n- If `externalId` is not specified, the filter will return all items which have some external ID at the specified `externalSystem`\n", "key": "externalSystem", "value": "" }, { "description": "Specifies which additional fields to include in the query results:\n- `name`: includes the incident name.\n- `description`: includes the incident description.\n- `tags`: includes the incident tags.\n- `externalIds`: includes the external IDs associated with the incident, which the caller has permission to access.\n- `company`: includes the company associated with the incident.\n", "key": "include", "value": "," }, { "description": "Filter incidents by status", "key": "status", "value": "," }, { "description": "Return only incidents that are pending redirection to the specified group.", "key": "pendingForGroup", "value": "" }, { "description": "filter incidents by the group (tier) which currently owns them (L1, L2, Customer)", "key": "group", "value": "" }, { "description": "Include only those which were updated before the specified timestamp (exclusive)", "key": "updatedBefore", "value": "" }, { "description": "Include only those which were updated after or at the specified timestamp (inclusive)", "key": "updatedAfter", "value": "" }, { "description": "Filters incidents by observable: only incidents linked to the specified observable will be returned. \nThis parameter specifies the observable's type, and it must be combined with the `observableValue` parameter. \n", "key": "observableType", "value": "" }, { "description": "Filters incidents by observable: only incidents linked to the specified observable will be returned. \nThis parameter specifies the observable's value, and it must be combined with the `observableType` parameter. \n", "key": "observableValue", "value": "" }, { "description": "Filters incidents by tags.\n\nNote: if more than one tag is specified, the client must specify the `tagsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "tags", "value": "" }, { "description": "Filters incidents by tags.\n\nNote: if more than one tag is specified, the client must specify the `tagsCondition` (otherwise: the server will return 400 Bad Request)\n", "key": "tags", "value": "" }, { "description": "If `tags` contains multiple items, determines the query predicate:\n- `any`: returns results which contain at least one of the specified tags\n- `all`: returns results which contain all of the specified tags\n", "key": "tagsCondition", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "c6604f8f-357b-46ea-947a-bf9eb2dc972c", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"ad\",\n \"key\": \"CDC-20191208-00046\",\n \"created\": \"1953-10-08T22:29:37.780Z\",\n \"updated\": \"1950-01-29T00:10:09.024Z\",\n \"type\": \"DDOS\",\n \"status\": \"Closed\",\n \"priority\": \"Low\",\n \"name\": \"Web Proxy - Execution file download\",\n \"description\": \"Customer Name - ACME Inc
Alert Name - Web Proxy - Execution file download
Device Product - Web Gateway
Category Outcome - /Failure
\\n\",\n \"group\": \"L1\",\n \"externalIds\": [\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n },\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"ACME Europe\",\n \"pendingForGroup\": \"Excepteur sunt\",\n \"redirectionReason\": \"quis labore ullamco\",\n \"endSlaDate\": \"2019-08-23T14:15:22Z\"\n },\n {\n \"id\": \"eiusmod in amet\",\n \"key\": \"CDC-20191208-00046\",\n \"created\": \"1988-05-12T13:34:00.731Z\",\n \"updated\": \"1992-08-06T22:30:53.505Z\",\n \"type\": \"DDOS\",\n \"status\": \"Closed\",\n \"priority\": \"Low\",\n \"name\": \"Web Proxy - Execution file download\",\n \"description\": \"Customer Name - ACME Inc
Alert Name - Web Proxy - Execution file download
Device Product - Web Gateway
Category Outcome - /Failure
\\n\",\n \"group\": \"L1\",\n \"externalIds\": [\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n },\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"ACME Europe\",\n \"pendingForGroup\": \"veniam commodo exercitation nulla dolor\",\n \"redirectionReason\": \"et labore nostrud do\",\n \"endSlaDate\": \"2019-08-23T14:15:22Z\"\n }\n ],\n \"nextMarker\": \"ut\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d81de2c5-f9e5-49cc-b20a-d3db35148188", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c5b06fa-0e7c-496a-aa4f-22115a3098da", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e69dc788-982e-4ddf-9b18-d04e95f340c5", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46054597-030d-4cc6-a8bb-2a040ae2c80a", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2a4f308-423d-441b-99a8-fb40d27cae85", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10a4f5bc-256c-4e69-8bc3-6bf87ec37c23", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ec4519a-e9a2-40e3-a252-20d33a71c53f", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "78a54711-d442-45d6-9492-8a6f59e2bc72", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38567007-3f60-43bd-9d0d-5875f82c8448", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "externalId", "value": "" }, { "key": "externalSystem", "value": "" }, { "key": "include", "value": "," }, { "key": "status", "value": "," }, { "key": "pendingForGroup", "value": "" }, { "key": "group", "value": "" }, { "key": "updatedBefore", "value": "" }, { "key": "updatedAfter", "value": "" }, { "key": "observableType", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "tags", "value": "" }, { "key": "tags", "value": "" }, { "key": "tagsCondition", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "1e465ae8-3a55-41a0-8108-ba07e8ceb027", "name": "{incident Id}", "item": [ { "id": "634ee891-1176-4fc1-83ab-94ad378da437", "name": "Returns a single incident", "request": { "name": "Returns a single incident", "description": {}, "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "6289a56d-d5ee-453f-a2e3-a42484a879b2", "name": "success", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sunt id\",\n \"key\": \"CDC-20191208-00046\",\n \"name\": \"Web Proxy - Execution file download\",\n \"description\": \"Customer Name - ACME Inc
Alert Name - Web Proxy - Execution file download
Device Product - Web Gateway
Category Outcome - /Failure
\\n\",\n \"created\": \"1994-06-07T00:43:26.506Z\",\n \"updated\": \"1993-05-22T09:23:33.493Z\",\n \"type\": \"DDOS\",\n \"status\": \"Closed\",\n \"priority\": \"Low\",\n \"group\": \"L1\",\n \"externalIds\": [\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n },\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"ACME Europe\",\n \"pendingForGroup\": \"in\",\n \"redirectionReason\": \"nulla ullamco id adipisicing\",\n \"endSlaDate\": \"2019-08-23T14:15:22Z\",\n \"closingComment\": \"ut reprehenderit Lorem minim\",\n \"closingReason\": \"True Positive\",\n \"closed\": \"2000-03-28T12:28:18.348Z\",\n \"cdcUrl\": \"https://acme.cyberproof.io/home/incidents/incident/5ea71bb363f6c6001707663b\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22901059-1bd3-499e-b57f-64f6de962257", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff380249-1bfc-46ba-a821-6b93e57205a5", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2a33289-574d-4e04-9232-6098184c5e74", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22602b4e-2c2a-4441-8658-d04ba4de1e18", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5524a5a9-95d1-4b00-8d03-57994e7b7213", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31f93f4b-1bfc-475e-a98c-fd4fb38319da", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5f0adae-d141-4bd1-afdc-bbd567ab2995", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f88e6a63-27df-4c0d-b460-6ff6af20e5a9", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c918de7-6648-44d7-988e-60f79d925819", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "de5fb46a-d383-44aa-b35d-91799588ed7d", "name": "Updates an incident", "request": { "name": "Updates an incident", "description": { "content": "A JSON object with details of the incident.
\n**NOTE:** The maximum request size is 100 KB.
\n**NOTE:** If `tags` is included, existing incident's tags are replaced with the specified ones.\n", "type": "text/plain" }, "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"priority\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "response": [ { "id": "63c119e0-e7fc-4179-ae05-3d9ed6a11020", "name": "The incident was updated", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "OK", "code": 200, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sunt id\",\n \"key\": \"CDC-20191208-00046\",\n \"name\": \"Web Proxy - Execution file download\",\n \"description\": \"Customer Name - ACME Inc
Alert Name - Web Proxy - Execution file download
Device Product - Web Gateway
Category Outcome - /Failure
\\n\",\n \"created\": \"1994-06-07T00:43:26.506Z\",\n \"updated\": \"1993-05-22T09:23:33.493Z\",\n \"type\": \"DDOS\",\n \"status\": \"Closed\",\n \"priority\": \"Low\",\n \"group\": \"L1\",\n \"externalIds\": [\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n },\n {\n \"system\": \"ServiceNow\",\n \"id\": \"40385fee\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"ACME Europe\",\n \"pendingForGroup\": \"in\",\n \"redirectionReason\": \"nulla ullamco id adipisicing\",\n \"endSlaDate\": \"2019-08-23T14:15:22Z\",\n \"closingComment\": \"ut reprehenderit Lorem minim\",\n \"closingReason\": \"True Positive\",\n \"closed\": \"2000-03-28T12:28:18.348Z\",\n \"cdcUrl\": \"https://acme.cyberproof.io/home/incidents/incident/5ea71bb363f6c6001707663b\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b933a3e9-956f-4147-8123-c949bc0d05dd", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4178ad88-1b85-42d8-b28d-4eddbd940cab", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48b0298a-03b0-4a5e-99fd-06cb7f52f27c", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4719b4e6-8a76-43ec-b824-41a5894f5eac", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24c731e2-f41d-423c-8edb-bf58066d268c", "name": "The attempted operation conflicts with the current state of the incident", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01131f94-821e-44e4-8f86-97870f29ea88", "name": "A precondition specified by the client was not met. This occurs if an etag was specified in an If-Match header, which doesn't match the etag found in the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c69f2a41-688a-4160-be58-227448bb60eb", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "015a710f-0864-4eeb-adb0-ff3b5a265707", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "382aaf9c-a43f-4c32-8273-ace44b4d389e", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "011d206e-bff4-4f39-b0a0-7a1929261b48", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0735bdc3-6d3f-4a63-80bc-4bb0eaba21e6", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c0d050c-c79e-4f64-a307-a8c5a693e750", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"company\": \"\"\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "8b860048-dad1-4afe-b639-87f2a52344be", "name": "Creates a new incident message", "request": { "name": "Creates a new incident message", "description": { "content": "Creates a new incident message in CDC.
\nThis operation is idempotent: if the client provides an external id which already exists in CDC, then the operation should succeed with UPSERT semantics.
\n**NOTE:** The maximum request size is 512 KB.\n", "type": "text/plain" }, "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"contentType\": \"\",\n \"content\": \"\",\n \"evidence\": {\n \"caption\": \"\",\n \"reported\": \"\",\n \"description\": \"\"\n }\n}" } }, "response": [ { "id": "b84be730-9253-4cbb-ba72-4b1c181ee3e1", "name": "The message has been created", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"text\": \"Requires further investigation\",\n \"processedText\": \"Requires further investigation\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ba7a7f-d916-4154-aa49-aa5f61cbb40b", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ac29d74-61cb-45c7-87f3-5beb8ad8f7ce", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c3ee03a-0e8b-4871-9420-36fae52e850d", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac17f742-3c6b-43fb-bed6-24c5337b8511", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "997b2c67-e992-437a-948e-c9b8f461e6ff", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8c642b6-3fe4-49e8-a3a9-2d6e3df3b785", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18eff728-7efc-424b-8bf4-a0ecd0f43d3c", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b29b319-abf2-4315-bf52-9c2b49cbc3cb", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25442db0-98c2-4716-b1f2-711215960e09", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"345ffe9a\",\n \"contentType\": \"text\",\n \"content\": \"Requires further investigation\",\n \"evidence\": {\n \"caption\": \"Severity changed\",\n \"reported\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\"\n }\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "a897a808-0027-4ddf-9c4a-3e04d27c78a1", "name": "Closes an incident", "request": { "name": "Closes an incident", "description": { "content": "A JSON object with details of the incident", "type": "text/plain" }, "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"\",\n \"closingReason\": \"deserunt et in\",\n \"shouldTerminatePlaybooks\": \"\"\n}" } }, "response": [ { "id": "c1e47cfa-2cb9-4af5-9fcb-16fcc6859efd", "name": "The incident was closed successfully", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "No Content", "code": 204, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e12c71a-0777-45f0-ab46-03a731fe2785", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "176861a8-3120-4b76-82e0-6de41ed3da6b", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cb5d693-9827-4c95-8c09-a9a3c61ff555", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7568bdf-27bf-462f-a7da-1dbbb29ae12f", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f12adb8b-f0d1-4294-a508-daad5eb89c4f", "name": "The attempted operation conflicts with the current state of the incident", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c9f94514-de3f-41af-b648-5f7f0648c90b", "name": "A precondition specified by the client was not met. This occurs if an etag was specified in an If-Match header, which doesn't match the etag found in the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de18cddd-523d-4dc0-aaaf-611e49a3d829", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81c74efa-f33c-4522-9255-eb59c2c182e3", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac4a90bd-0c4a-4b73-8908-1a7be29e60f4", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7b48118-e313-4b03-8e69-7ee93fee7131", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c84e6edb-b2ae-44cf-8857-bdbe81b88312", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "close" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"closingComment\": \"This incident has been investigated and was deemed to be a false alarm - the user had their CAPSLOCK on, which is why they entered the wrong password\"\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "a721acb4-d13a-43e5-8f01-cd347857ddfe", "name": "initiate a redirection", "request": { "name": "initiate a redirection", "description": {}, "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "response": [ { "id": "6a7f63e5-3d4f-4601-ba32-862d16d25f70", "name": "The redirection has been issued", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "No Content", "code": 204, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8bc3486f-27b1-4d15-b114-1ede030bd276", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97299280-7fae-4f55-9568-e9772d8ca08b", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "235b2da9-de49-4425-bdc9-2b6b8522a3cd", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb1ea522-a6fb-4b79-8763-cb89e8eebabe", "name": "The specified incident was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "170cb888-d1ed-47f0-a003-3f4a772ad12b", "name": "The attempted operation conflicts with the current state of the incident", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4613ca4b-8c20-4958-b10b-aa79a8f302b3", "name": "A precondition specified by the client was not met. This occurs if an etag was specified in an If-Match header, which doesn't match the etag found in the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29fed739-0e27-4e11-ba25-7d910e222c19", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd9f882e-2dc4-49ee-bc32-c21ed24b02bb", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f00b55f1-0ed4-4ad1-a841-3e58ef5025e5", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ca91654-1f96-48ba-b124-fd95d31eb4c2", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83751788-a7a8-4c53-8103-10e2ae1e2597", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"targetGroup\": \"\",\n \"reason\": \"\"\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "7ba3782f-de5d-4c34-8a89-7a7b0b85bc01", "name": "accepts a redirection request", "request": { "name": "accepts a redirection request", "description": {}, "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "auth": null }, "response": [ { "id": "1adfca2b-aee7-4a21-bb6e-02f408035424", "name": "The redirection has been successfully accepted", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7e54206-09ce-40cb-8990-ea7b7180172f", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5743996c-6cbf-4a18-9dfc-b5530e5ecd67", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93bfb2ef-2426-43d6-a10c-272d5bf68785", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c6b8a64-e9b1-40fa-ba2c-fec7ce82120a", "name": "The specified incident was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6277ccd-4933-4248-b9a2-f41b303acc60", "name": "There currently isn't any pending redirection for this incident", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3541fb0a-b37f-4fd0-80cd-6a223db62e43", "name": "A precondition specified by the client was not met. This occurs if an etag was specified in an If-Match header, which doesn't match the etag found in the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca31e8a8-5a3a-4aee-9c2a-6dcf2f332f0f", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b028eae7-04fe-44bc-9ed3-279a37f3a3b0", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b8f9c4d-705b-4b2d-9889-300a73c344bc", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4e894485-7d17-4894-9132-fa23c36a1d68", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "085dd4d0-d284-4412-a82d-8a000cbdad7b", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "header": [ { "description": "Enables conditional modification - the resource will be modified only if its current etag matches the value specified in this header, otherwise - 412 \"Precondition Failed\" will be returned to the client", "key": "If-Match", "value": "" } ], "method": "POST", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "92bd5d58-8e3a-4cba-bb16-e54b2d020dc1", "name": "Returns information about the alerts associated with this incident.", "request": { "name": "Returns information about the alerts associated with this incident.", "description": {}, "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "Specifies which additional fields to include in the query results:\n- `raw`: includes the raw alert data.\n- `company`: includes the company field.\n", "key": "include", "value": "," } ], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "8402c5f7-2dda-4ea8-8875-e211a5cbecb7", "name": "success", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"fugiat proident\",\n \"score\": 33.2,\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"created\": \"2011-06-06T07:14:23.220Z\",\n \"modified\": \"1962-12-05T03:52:06.027Z\",\n \"detected\": \"1953-12-16T09:55:36.691Z\",\n \"status\": \"In Incident\",\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"classification\": \"Authentication\",\n \"observableTags\": [\n \"E/e\",\n \"%V\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"killChain\": [\n \"Acti\",\n \"Weap\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"cdcUrl\": \"https://acme.cyberproof.io/home/alerts/alert/5e7c6cf54b832e0018f191ad\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"id sunt\",\n \"nisi\"\n ],\n \"ctiSourceUrls\": [\n \"officia Lorem dolore amet\",\n \"ut dolore qui aliquip dolor\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\"\n },\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"amet ad reprehenderit id exercit\",\n \"score\": 33.2,\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"created\": \"1995-10-05T02:02:40.118Z\",\n \"modified\": \"1990-07-01T06:44:38.397Z\",\n \"detected\": \"2020-04-17T00:25:14.058Z\",\n \"status\": \"In Incident\",\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"classification\": \"Authentication\",\n \"observableTags\": [\n \"H-\",\n \".~O\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"killChain\": [\n \"Expl\",\n \"Reco\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"raw\": {\n \"attributeInitializationInProgress\": false,\n \"createdTime\": {\n \"day\": {\n \"numberInt\": \"18\"\n },\n \"hour\": {\n \"numberInt\": \"16\"\n },\n \"milliSecond\": {\n \"numberInt\": \"711\"\n },\n \"minute\": {\n \"numberInt\": \"10\"\n },\n \"month\": {\n \"numberInt\": \"6\"\n },\n \"second\": {\n \"numberInt\": \"47\"\n },\n \"timezoneID\": \"Israel\",\n \"year\": {\n \"numberInt\": \"2017\"\n }\n },\n \"createdTimestamp\": {\n \"numberDouble\": \"1500383447711\"\n },\n \"deprecated\": false,\n \"description\": \"ACME\",\n \"disabled\": false,\n \"inCache\": true,\n \"inactive\": false,\n \"initialized\": true,\n \"isAdditionalLoaded\": false,\n \"localID\": {\n \"numberDouble\": \"30064798760\"\n },\n \"modificationCount\": {\n \"numberInt\": \"1\"\n }\n },\n \"cdcUrl\": \"https://acme.cyberproof.io/home/alerts/alert/5e7c6cf54b832e0018f191ad\",\n \"threatActors\": [\n \"Cyber Criminals\",\n \"Anonymous\"\n ],\n \"malwareTools\": [\n \"Ut ad\",\n \"voluptate pariatur veniam ullamco\"\n ],\n \"ctiSourceUrls\": [\n \"irure\",\n \"occaecat reprehenderit est\"\n ],\n \"recommendations\": \"Implement the attached IOCs in your security systems.\"\n }\n ],\n \"nextMarker\": \"eiusmod ullamco in\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7a7e452-5310-44ca-81c0-331e2c12072b", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af4ddc0d-962d-47e4-8889-dec3f646d040", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43395a68-0768-42f1-bb5f-1618d1161a9b", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "116eeff3-63d0-4255-b594-c4a45ba9870e", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49e3eedc-ab36-42d5-a705-095d2790bff1", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "778792d5-5c98-43f1-8d46-eba80c28d91c", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49ef2458-f78a-498c-b186-2427b3902f09", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ef99efa-21db-4fa7-b5f2-aad8546f5dfb", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3eac3cd-7862-46cf-93da-6ec52fd9159e", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9ebffda-3565-4bca-b433-f2150213c143", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alerts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "384ae46d-2b20-4395-a9de-7878b8072949", "name": "Returns the IDs of the alerts associated with this incident.", "request": { "name": "Returns the IDs of the alerts associated with this incident.", "description": {}, "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" } ], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "9c29c60d-cd78-4d13-b607-ea52857240fd", "name": "success", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n \"voluptate in\",\n \"tempor minim ut fugiat\"\n ],\n \"nextMarker\": \"veniam\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "115205db-3825-4a8c-8bf0-9faf02b9e19a", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "efdacdbf-8a52-43c5-b6de-2aad8cf53c37", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "699b066c-f2b1-4658-b774-069ece2e3cc9", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11254501-eaf0-4325-9051-7c75b3be4012", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c258b21f-7463-4c82-ac2f-ac524ebfd305", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c427d229-35b3-4978-abda-fa338085f058", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5cfa7510-0a09-4c76-b3b6-fb2e182160dc", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46d1b87d-3167-42ab-98fd-5106731983d4", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ea58e0f-0e3a-499c-a4ac-7e9f18c7d023", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "a91af042-863c-4231-a7a1-1e7c5678af2c", "name": "observables", "item": [ { "id": "dda4cccb-f365-4ac2-8b03-102983a71c96", "name": "Returns information about the observables associated with this incident.", "request": { "name": "Returns information about the observables associated with this incident.", "description": {}, "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" } ], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "76bb55db-428e-4864-ac7c-cbcdbad190ad", "name": "success", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"created\": \"1991-03-12T22:20:31.405Z\",\n \"updated\": \"1963-01-20T17:47:26.678Z\",\n \"suspiciousRate\": 3.2,\n \"tags\": [\n \"Critical-Infrastructure\"\n ],\n \"enrichments\": [\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"1984-07-04T21:19:46.544Z\",\n \"suspiciousRate\": 3.2\n },\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"2016-04-15T10:22:19.096Z\",\n \"suspiciousRate\": 3.2\n }\n ],\n \"isIoc\": false\n },\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"created\": \"1957-04-28T08:29:13.466Z\",\n \"updated\": \"2002-03-13T06:43:42.147Z\",\n \"suspiciousRate\": 3.2,\n \"tags\": [\n \"Critical-Infrastructure\"\n ],\n \"enrichments\": [\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"2009-08-19T01:42:42.278Z\",\n \"suspiciousRate\": 3.2\n },\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"1987-01-17T02:05:21.475Z\",\n \"suspiciousRate\": 3.2\n }\n ],\n \"isIoc\": false\n }\n ],\n \"nextMarker\": \"par\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97f8734b-eb7e-4cdf-b93a-d442372ce9c0", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a90cf165-5226-404e-8c5f-4df18ae809b9", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c0cc4e9-18f6-4c14-9459-66b67df51c31", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5dae116-0a63-4ff2-af91-a58632adcead", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e890a37e-ef81-41f4-8f96-da7c65fd2208", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "677e6ba6-f390-4ed2-8bac-02fabfd2eecc", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47d8c702-e065-4129-a28a-fec719d50eab", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a6979f8-13a2-423a-8d15-5ff27dc90163", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0251be46-cf54-4b78-ac30-c156ca2020fd", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bdd7e0ee-fe68-4c31-9b03-7ca553b2a214", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "cd525bf8-f4ca-47e9-a865-2037482166be", "name": "Creates a new incident observable", "request": { "name": "Creates a new incident observable", "description": { "content": "Creates a new incident observable in CDC
\nThis operation is idempotent: if the client provides a type and value which already exist in CDC, then the operation should succeed with UPSERT semantics.
\n**NOTE:** The maximum request size is 100 KB.\n", "type": "text/plain" }, "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"value\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "response": [ { "id": "dee257de-8ef0-4ad1-ae3f-0f760b1e1827", "name": "The observable has been created", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5e13b88122c957000787db06\",\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"created\": \"1971-12-09T22:58:35.313Z\",\n \"updated\": \"2005-07-20T12:57:03.692Z\",\n \"suspiciousRate\": 3.2,\n \"tags\": [\n \"Fw>k]p26LU\",\n \"%\"\n ],\n \"enrichments\": [\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"2022-11-25T08:27:03.836Z\",\n \"suspiciousRate\": 3.2\n },\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"1969-06-11T19:25:56.822Z\",\n \"suspiciousRate\": 3.2\n }\n ],\n \"isIoc\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03cb3761-8786-4515-a036-b1f98a813945", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97f3dbed-162d-4fa5-b5ae-ee3b9d1c4bf5", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cbcad22-ab78-4073-9c6f-ed9c91648b9b", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f2ea0f3-5f0c-4557-b685-f42dc1559132", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8bc6e3ca-c812-4402-b45b-ea1ec4e97232", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dccefa9d-82b6-4b39-8c3d-9c8ddf5ab9d1", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fc4db968-a901-4238-b6bb-72a4426e9408", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6761c612-6a79-4c76-8d13-e554b20264b4", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28b4f02a-d8e9-40c0-9c4f-529de8e6850f", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "f6e313fd-9c5c-4d47-9cc6-f48890c46f1f", "name": "evidence", "item": [ { "id": "5e6c4027-afbc-4e5a-abdd-5d39beff623c", "name": "Returns information about the evidence associated with this incident.", "request": { "name": "Returns information about the evidence associated with this incident.", "description": {}, "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "Specifies which additional fields to include in the query results:\n- `data`: includes the evidence metadata.\n", "key": "include", "value": "," } ], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "fedb307e-6987-469f-9489-9b1963abbce2", "name": "success", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"5aa4d8fcbdee5a000a911882\",\n \"type\": \"MITRE_ATTACK_ADDED\",\n \"reported\": \"1960-12-16T00:03:15.881Z\",\n \"created\": \"1974-08-27T15:48:09.975Z\",\n \"caption\": \"Severity changed\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"messageId\": \"cupidatat dolore occaecat in\",\n \"messageCdcUrl\": \"https://acme.cyberproof.io/home/incidents/5ea71bb363f6c6001707663b/evidence/5ea71bb363f6c6001707254a\",\n \"externalId\": \"345ffe9a\",\n \"data\": {}\n },\n {\n \"id\": \"5aa4d8fcbdee5a000a911882\",\n \"type\": \"MITRE_ATTACK_ADDED\",\n \"reported\": \"1955-02-24T22:44:18.988Z\",\n \"created\": \"1980-11-06T06:57:57.336Z\",\n \"caption\": \"Severity changed\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"messageId\": \"aliqua\",\n \"messageCdcUrl\": \"https://acme.cyberproof.io/home/incidents/5ea71bb363f6c6001707663b/evidence/5ea71bb363f6c6001707254a\",\n \"externalId\": \"345ffe9a\",\n \"data\": {}\n }\n ],\n \"nextMarker\": \"mollit sunt ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8466c93-a24b-4a09-9c02-1f481c94b52f", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bbbc5977-57e3-4643-900e-edf719d2d5d0", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f23a6b7-1475-4d9f-9e27-4a59c150e57d", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b374d7d-accb-4c2f-83de-b93bffefa665", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cffe1313-d12e-47e6-be0b-5737a5ce1649", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35090688-4a8e-46ed-bc20-f0a1f3ede2ee", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38a1da23-fe00-4efe-bc79-130bcdf3c288", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24f1ce43-db71-4538-a0e1-df0858f349e3", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef4cfadb-0498-43b9-86d4-6c47b7e8a1ef", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ebf4e4c-05bc-4dbd-a438-146a1d77a3da", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "include", "value": "," }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "e90823a8-c0f7-4109-b942-d456eb3e44b8", "name": "Creates a new incident evidence", "request": { "name": "Creates a new incident evidence", "description": {}, "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) The unique ID of the incident", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"\",\n \"messageId\": \"\",\n \"description\": \"\",\n \"externalId\": \"\"\n}" } }, "response": [ { "id": "27583a5d-8aab-4eda-a3a3-6c4981b6d6bc", "name": "The evidence has been created", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5aa4d8fcbdee5a000a911882\",\n \"type\": \"MITRE_ATTACK_ADDED\",\n \"reported\": \"1954-01-04T06:46:48.002Z\",\n \"created\": \"1971-08-12T12:21:22.328Z\",\n \"caption\": \"Severity changed\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"messageId\": \"consectetur nostrud\",\n \"messageCdcUrl\": \"https://acme.cyberproof.io/home/incidents/5ea71bb363f6c6001707663b/evidence/5ea71bb363f6c6001707254a\",\n \"externalId\": \"345ffe9a\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "541bffcb-5c91-4e1d-a5e8-f0b1d8c0d7f0", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07e0d443-b809-413c-9090-9572f224f49e", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a204f44b-fb08-4f62-a6d4-d3d08375322d", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b55c6fbb-5fd7-456d-b96a-b9b2da6eb042", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38fe0886-698e-45d2-8b90-2205ea91582a", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b21645b-a23c-4508-85d8-23803e461feb", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cd19f64-683b-4759-8578-f6bf3a4be4f4", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79e04524-dd43-4a95-90e2-1f9b0c7b92bd", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0259b2b-0fda-4826-8dee-e542ce43c501", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18ada658-3926-4082-b761-c4358cf8614b", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b2539e6-5b4d-4caf-985f-789d7968d69c", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reported\": \"\",\n \"caption\": \"Severity changed\",\n \"messageId\": \"\",\n \"description\": \"System Admin has changed severity from Low to Medium\",\n \"externalId\": \"345ffe9a\"\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "f851e571-f08d-4575-9836-d6f2d6827147", "name": "summary", "item": [ { "id": "2a13b3f0-3cf0-42e9-aa65-78693bbdf144", "name": "Query incident summary", "request": { "name": "Query incident summary", "description": { "content": "Query incident summary with support for filters and pagination. Default limit is 1000 docs per request.", "type": "text/plain" }, "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "List of the internal field name of the custom-field schema", "key": "names", "value": "" }, { "description": "List of the internal field name of the custom-field schema", "key": "names", "value": "" }, { "description": "List of the db`s document identifier", "key": "ids", "value": "" }, { "description": "List of the db`s document identifier", "key": "ids", "value": "" }, { "description": "", "key": "marker", "value": "" } ], "variable": [ { "description": "(Required) ", "type": "any", "value": "", "key": "incidentId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "9b68b5e9-6d15-4273-9922-2dfb4d9127a4", "name": "Response for query incident summary public", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"name\": \"sed dolor nostrud consequat anim\",\n \"id\": \"velit sit est\",\n \"createdBy\": \"sit officia\",\n \"updatedBy\": \"laboris ipsum nostrud dolore\",\n \"createdAt\": \"velit cillum officia Duis aliquip\",\n \"updatedAt\": \"proident cillum\",\n \"value\": {}\n },\n {\n \"name\": \"veniam labore Exc\",\n \"id\": \"Excepteur dolor\",\n \"createdBy\": \"officia incidi\",\n \"updatedBy\": \"reprehenderit consectetur dolor\",\n \"createdAt\": \"amet\",\n \"updatedAt\": \"elit consequat Ut nostrud\",\n \"value\": {}\n }\n ],\n \"nextMarker\": \"mollit velit Lorem adipisicing\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "243aa233-c07a-45bb-a9ca-ce4fe18d444d", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67b567c1-0784-4cb8-9fb9-17ed5f2addf7", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c569e3a-b3f2-4de7-b283-14da86fe7165", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "230d05b9-ebb4-4893-b18f-f14e278432ef", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f5a4f35-2cb9-45e3-9295-bb5530ef882c", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4eb2c9fc-eeac-4ed2-b16f-5356d0f66a1a", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e66ff1e-d203-46f1-a011-79a95a2b4c7a", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "197d1d1b-41d9-4d39-9eec-b17170cc3528", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12e88c27-d939-43ae-933e-e61f0787f60d", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc054bda-fb34-480f-acdc-c4daaea7893c", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "names", "value": "" }, { "key": "names", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "6e0fb985-5ddf-40d8-81a4-9a4e653cb4d1", "name": "Set incident summary", "request": { "name": "Set incident summary", "description": { "content": "Set incident summary", "type": "text/plain" }, "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "(Required) ", "type": "any", "value": "", "key": "incidentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "response": [ { "id": "ec71b965-8c07-4352-82b6-53d66fcd4235", "name": "Response for Create incident summary", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"name\": \"magna deserunt aliqua ea\",\n \"id\": \"labore enim magna\",\n \"createdBy\": \"anim do \",\n \"updatedBy\": \"consectetur sint\",\n \"createdAt\": \"pariatur amet\",\n \"updatedAt\": \"et Lorem officia mollit cillum\",\n \"value\": {}\n },\n {\n \"name\": \"do\",\n \"id\": \"volupta\",\n \"createdBy\": \"sit anim\",\n \"updatedBy\": \"dolor velit o\",\n \"createdAt\": \"minim exercitation\",\n \"updatedAt\": \"voluptate\",\n \"value\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d721abf-d4e2-4441-ad9b-fb65b01f3d38", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bb2cac3-5de2-420e-b39e-c8d240ca7ede", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b1b7e8f-171c-47a4-9033-c0ebda6b8e92", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59507fce-dbf1-44b9-a68b-8cbe1c6da2b3", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "519ffc29-f8af-4832-ab43-c7775c643f67", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7eb96def-96ab-4a7e-adf8-e2163c9d940e", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd6a09a7-4d96-40a0-a537-1551688f81c9", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c942559a-87ae-464c-9e0c-daa01ce04170", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a03fb0b2-514f-468e-b286-8edb3f4d987d", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c00ef17-7b46-43db-a523-3dc927647f7e", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "incidents", ":incidentId", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "incidentId" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "bf564dff-a52b-459d-8b68-e66affc926da", "name": "observables", "item": [ { "id": "f8aa7a20-53a0-45e9-bdab-013c3f5314a1", "name": "Gets the specified observable based on its type and value.\n", "request": { "name": "Gets the specified observable based on its type and value.\n", "description": {}, "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "(Required) The type of the observable", "key": "observableType", "value": "" }, { "description": "The type of the observable.\n**Deprecated**: please use `observableType` instead of `observable_type`\n", "key": "observable_type", "value": "" }, { "description": "(Required) The value of the observable", "key": "observableValue", "value": "" }, { "description": "The value of the observable.\n**Deprecated**: please use `observableValue` instead of `observable_value`\n", "key": "observable_value", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "a6f570b2-031b-4607-b445-5a29dfbc9b96", "name": "A JSON object containing the observable", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5e13b88122c957000787db06\",\n \"type\": \"IPv4 Address\",\n \"value\": \"192.168.40.45\",\n \"created\": \"1971-12-09T22:58:35.313Z\",\n \"updated\": \"2005-07-20T12:57:03.692Z\",\n \"suspiciousRate\": 3.2,\n \"tags\": [\n \"Fw>k]p26LU\",\n \"%\"\n ],\n \"enrichments\": [\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"2022-11-25T08:27:03.836Z\",\n \"suspiciousRate\": 3.2\n },\n {\n \"id\": \"5e13b88122c957000787db06\",\n \"name\": \"VirusTotal\",\n \"reported\": \"1969-06-11T19:25:56.822Z\",\n \"suspiciousRate\": 3.2\n }\n ],\n \"isIoc\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98887f84-4ade-41c2-8e8a-c6e6fee76d16", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73f89ff9-4f30-4442-aa2b-77e367c8a740", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01bd59f0-3b46-4dac-9986-6c879b3267b7", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e999540a-58e4-4b1e-8ec1-bf72801fb4f7", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6939c53b-26d0-4431-8ad5-a9e09c79a9d0", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf9db100-683d-49f6-b8e5-53b59fd2128f", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39e60c5b-d90b-486c-844a-ac99c6644227", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87d38fe8-e49e-410d-9752-0f3f6145a5c2", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ebb2672-3b2c-4e55-8960-70814144e3a7", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "observables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "ca3dd67b-af65-4de6-a5ef-51636f4fbe8c", "name": "Queries alert IDs associated with the observable.\n", "request": { "name": "Queries alert IDs associated with the observable.\n", "description": {}, "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "(Required) The type of the observable", "key": "observableType", "value": "" }, { "description": "The type of the observable.\n**Deprecated**: please use `observableType` instead of `observable_type`\n", "key": "observable_type", "value": "" }, { "description": "(Required) The value of the observable", "key": "observableValue", "value": "" }, { "description": "The value of the observable.\n**Deprecated**: please use `observableValue` instead of `observable_value`\n", "key": "observable_value", "value": "" }, { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "6092a47e-0ead-410e-8f4d-73ba9e9d5cc7", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n \"Excepteur exercitation labore\",\n \"nisi deserunt\"\n ],\n \"nextMarker\": \"eu dolore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a3ebba-60cd-4c40-a1b4-98ebf04ccd79", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d98c871-f0fc-4911-bf36-db819b5517b6", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f4ec9b7-9d3f-4bfa-ace6-d85286861d27", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "212b6bff-3aeb-4e0d-a2a9-70df4d7e750d", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4deeb39-def1-41b5-bc11-b6330dc21196", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "662e2cbc-2c3e-4e97-8f1a-fb16630d7227", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82c63874-5150-45e2-93fd-cdf236652647", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9845681c-b4ca-4348-bd8d-cb707a29ad4a", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ee39091-3127-4dfd-a692-4d3daa5f08e0", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "observables", "alert-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "726d47bc-d668-4e91-9352-4687e3cd0619", "name": "Queries incident IDs associated with the observable.\n", "request": { "name": "Queries incident IDs associated with the observable.\n", "description": {}, "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "(Required) The type of the observable", "key": "observableType", "value": "" }, { "description": "The type of the observable.\n**Deprecated**: please use `observableType` instead of `observable_type`\n", "key": "observable_type", "value": "" }, { "description": "(Required) The value of the observable", "key": "observableValue", "value": "" }, { "description": "The value of the observable.\n**Deprecated**: please use `observableValue` instead of `observable_value`\n", "key": "observable_value", "value": "" }, { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "d78ca709-9ca0-4f81-aa76-e5c7e70ed1f8", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n \"mollit ullamco ut dolore\",\n \"amet sunt veniam\"\n ],\n \"nextMarker\": \"ut in\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1897600a-45ca-4d67-850f-2cefe45b9584", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e632f30-7180-4c53-bc15-4e56b36fffbe", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3aceee4a-7520-4b14-88fb-9eeb2c1ffa7c", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6ff967d9-39c7-4166-b2c8-c799746c6279", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d79ed38-4e3c-46b2-8fb6-f5acb49029f7", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5f49962-2e6a-4c71-99f0-43bb6d2c674d", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73b2e143-ddda-43ef-b366-d351778e8f58", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60aac3f5-3b35-4630-b772-c37d5989a9f5", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b674d17-568d-4147-ad02-2c851dd39510", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "observables", "incident-ids" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "observableType", "value": "" }, { "key": "observable_type", "value": "" }, { "key": "observableValue", "value": "" }, { "key": "observable_value", "value": "" }, { "key": "marker", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "7cedadbe-6fff-48dc-b9ae-83b2918c63ba", "name": "messages", "item": [ { "id": "217dcd6b-1eb1-4614-8822-8c9f073762cd", "name": "Create a new message", "request": { "name": "Create a new message", "description": {}, "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"\",\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"\"\n },\n \"parentMessageId\": \"\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "response": [ { "id": "bcd6f2e4-4659-4078-b103-9b184815c6ba", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"616ea579f2631c8d4c68a1b7\"\n ],\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"attachments\": [\n {\n \"status\": \"processing\",\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"name\": \"attachment.txt\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"url\": \"https://someDomain/somePath/attachment.txt\",\n \"size\": 2680000,\n \"mimeType\": \"text/plain\",\n \"createdAt\": \"1959-09-13T19:11:53.335Z\",\n \"createdBy\": \"8e2c4cf54b832e0018f191ad\",\n \"extension\": \"txt\",\n \"relations\": [\n {\n \"type\": \"vega\"\n }\n ]\n },\n {\n \"status\": \"processing\",\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"name\": \"attachment.txt\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"url\": \"https://someDomain/somePath/attachment.txt\",\n \"size\": 2680000,\n \"mimeType\": \"text/plain\",\n \"createdAt\": \"1984-09-19T04:20:56.257Z\",\n \"createdBy\": \"8e2c4cf54b832e0018f191ad\",\n \"extension\": \"txt\",\n \"relations\": [\n {\n \"type\": \"vega\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aa06901-4f2c-4305-882c-b188eecf2bee", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dae28461-6065-4670-a08e-c25c7d031d61", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec32aace-4788-44fd-8a9a-a034b74e5ddc", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d9f4dfd-9d53-4fe1-8be4-904c9c259f09", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85f504ce-8976-412f-8a04-2f1fba867cd7", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c848ba00-bc2e-4d6d-87d5-acc76e59757f", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80f1f78d-d753-4ec1-ad16-e78c2066edb7", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e5315fe-9a09-4572-98eb-ee03b85d5216", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "549d149e-5570-4ac5-a03f-26c4df4039fa", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"\",\n \"\"\n ]\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "40139069-d00e-4643-b4ed-4c9908979204", "name": "Queries messages based on filters provided by the client.\nFor synchronization purposes, the `updatedAfter` filter option should be used.\n", "request": { "name": "Queries messages based on filters provided by the client.\nFor synchronization purposes, the `updatedAfter` filter option should be used.\n", "description": {}, "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "(Required) The type of the entity ( alert / incident / channel ...)", "key": "scopeType", "value": "" }, { "description": "filter by id of the entity as saved in the system must be supplied with scopeType.", "key": "scopeId", "value": "" }, { "description": "filter by messages that include a file by this name as attachment note- if \"fileIds\" is supplied this field is ignored", "key": "fileNames", "value": "" }, { "description": "filter by messages that include a file by this name as attachment note- if \"fileIds\" is supplied this field is ignored", "key": "fileNames", "value": "" }, { "description": "filter by files that include a file by this id as attachment note- this takes precedent over \"fileNames\"", "key": "fileIds", "value": "" }, { "description": "filter by files that include a file by this id as attachment note- this takes precedent over \"fileNames\"", "key": "fileIds", "value": "" }, { "description": "filter by either with or wihtout attachments", "key": "hasAttachments", "value": "" }, { "description": "Include only those which were created by a specific user ID", "key": "createdBy", "value": "" }, { "description": "Include only those which were created before the specified timestamp (exclusive)", "key": "createdBefore", "value": "" }, { "description": "Include only those which were created after or at the specified timestamp (inclusive)", "key": "createdAfter", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "3dfdff5b-2b6c-4332-b065-dd95c8d93ee0", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"616ea579f2631c8d4c68a1b7\"\n ]\n },\n {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"externalId\": \"111e3cf9-da0e-46a1-b099-3fd2e653ecbd\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"content\": {\n \"contentType\": \"\",\n \"message\": \"some text bold message\"\n },\n \"parentMessageId\": \"616ea579f2631c8d4c68a1b7\",\n \"attachmentIds\": [\n \"616ea579f2631c8d4c68a1b7\"\n ]\n }\n ],\n \"nextMarker\": \"est dolore ea magna\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4f240ef-fd59-4369-9462-45ee88eb450d", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7974b0ec-1376-4e02-92d7-6c43febecfed", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b6d0204-ff76-4812-b537-3fa40ebabf52", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fc93f660-d630-47e3-bd71-66bbea1ea584", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e9e60af-674a-4566-b172-af1ec9997aac", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7ffe5a9-a3e7-4d81-839a-c73db7a15647", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b546052-a7c9-48b8-9f7d-694374cb0d28", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ce03ed0-baaa-4851-8c77-e2820f22f852", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4950ff73-1477-4205-9534-d0b42bdd976b", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileNames", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "fileIds", "value": "" }, { "key": "hasAttachments", "value": "" }, { "key": "createdBy", "value": "" }, { "key": "createdBefore", "value": "" }, { "key": "createdAfter", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "352e657e-a41c-40a9-a2a2-a9a3d69283dd", "name": "search", "item": [ { "id": "0291ff7f-88d4-4d0e-b351-c4842b757a2d", "name": "Returns result of Search QL", "request": { "name": "Returns result of Search QL", "description": {}, "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"include\": \"\",\n \"limit\": 20,\n \"skip\": 0,\n \"sort\": \"\",\n \"includeTotal\": false\n}" } }, "response": [ { "id": "5b60101d-86db-46d8-97a3-a36b7ee70bde", "name": "A JSON object containing the observable", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "OK", "code": 200, "header": [ { "description": "Includes an identifier for a specific version of a resource. Commonly used as the basis for conditional gets and conditional updates.", "key": "ETag", "value": "veniam ea occaecat" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sort\": [\n {\n \"fieldName\": \"string\",\n \"desc\": true\n },\n {\n \"fieldName\": \"string\",\n \"desc\": true\n }\n ],\n \"limit\": 20,\n \"skip\": 0,\n \"items\": [\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"labore consequat\",\n \"score\": 33.2,\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"created\": \"1985-05-05T10:29:47.364Z\",\n \"modified\": \"1965-01-17T19:46:44.964Z\",\n \"detected\": \"2019-03-16T17:29:01.704Z\",\n \"status\": \"In Incident\",\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"classification\": \"Authentication\",\n \"observableTags\": [\n \"(~u\",\n \"\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"killChain\": [\n \"Acti\",\n \"Inst\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"summaryType\": \"alert\",\n \"incidentId\": \"reprehenderit in esse Lorem\"\n },\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"source\": \"QRadar\",\n \"sourceId\": \"Excepteur irure\",\n \"score\": 33.2,\n \"name\": \"Windows - Multiple failed logins same user same host\",\n \"description\": \"Customer Name - AcmeCo\\nAlert Name - Windows - Multiple failed logins same user same host\\nDevice Vendor - Microsoft\\nDevice Product - Microsoft Windows\\nDevice Event Class Id - rule:105\\n\",\n \"severity\": \"Medium\",\n \"created\": \"1979-03-03T19:14:44.783Z\",\n \"modified\": \"1991-02-25T07:47:43.647Z\",\n \"detected\": \"2024-07-03T21:37:10.597Z\",\n \"status\": \"In Incident\",\n \"sourceUrl\": \"https://192.168.41.164/console/do/sem/offensesummary?appName=Sem&pageId=OffenseSummary&summaryId=296\",\n \"company\": \"ACME Europe\",\n \"useCase\": \"UC216 - EPP - Persistent Malware\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"classification\": \"Authentication\",\n \"observableTags\": [\n \"9xK%X=8L\",\n \"$jA''q\"\n ],\n \"categories\": [\n \"Ransomware\",\n \"Phishing\"\n ],\n \"detectionRule\": \"WRONG_PASSWORD_3_ATTEMPTS\",\n \"killChain\": [\n \"Reco\",\n \"Comm\"\n ],\n \"mitreAttacks\": [\n \"\",\n \"\"\n ],\n \"alertType\": \"CTI-Landscape\",\n \"threatType\": \"Phishing\",\n \"summaryType\": \"alert\",\n \"incidentId\": \"Duis nisi pariatur\"\n }\n ],\n \"total\": 32\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85679570-0c62-493d-b49f-c2024b67e8f7", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21d7fd52-e060-423a-9281-2636aa29d0fb", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "441be437-29cf-4cd2-8dd3-b16c2414f420", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "791001a3-2e31-470f-b225-e9c8a416df45", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9836dd1b-07d3-40e8-86eb-3f5c202cfefc", "name": "The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. The client should not repeat this request without modification.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb0c96bd-bccf-4c8c-8a45-2316f5bb5321", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "acb1f7a2-8e86-4884-b0f9-f23de4dee5e6", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2b131c1-adbc-4c4a-abb2-0334f627e80b", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "912fdc81-7d8a-404d-a830-9356b91a76cb", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb3bad09-0894-4a53-afee-4f6bf721a54b", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"query\": \"select from alert where status = 'New'\",\n \"include\": \"name,status,severity,description\",\n \"limit\": 10,\n \"skip\": 0,\n \"sort\": \"created\",\n \"includeTotal\": true\n}" } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "4210a61c-4213-4f1d-98ec-55dbdee48ace", "name": "Returns result of autocomplete", "request": { "name": "Returns result of autocomplete", "description": {}, "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "**Required** in case collection is not \"**alertExtraProperties**\" or \"**observableExtraProperties**\"\nThe value of \"fieldName\" depends on \"collection\". Example collection=\"alert\" fieldName=\"classification\"\n- message\n - text\n- alert\n - tags\n - observableTags\n - owner\n - mitreAttacks\n - type\n - closingReason\n - name\n - description\n - source\n - sourceId\n - sourceUrl\n - detectionRule\n - killChain\n - classification\n - threatActors\n - malwareTools\n - severity\n - status\n - threatType\n - company\n - useCase\n- observable\n - tags\n - value\n - type\n- incident\n - tags\n - owner\n - users\n - mitreAttacks\n - status\n - company\n - source\n - name\n - description\n - group\n - key\n - type\n - priority\n - closingReason\n", "key": "fieldName", "value": "" }, { "description": "", "key": "substring", "value": "" }, { "description": "", "key": "limit", "value": "10" }, { "description": "(Required) ", "key": "collection", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "771c8b07-6ff2-4ad7-80c1-0d361b422593", "name": "A JSON object containing the results", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"limit\": 10,\n \"items\": [\n \"dolor labore non commodo Lorem\",\n \"laboris ad occaecat\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a1fe6db-94f9-4572-941a-570dd5d7cda1", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fce70c2f-2c76-49a4-86b9-b91ff308afed", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "276a2ddf-7425-43f0-a088-6f8ff782ad81", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e12f344d-6a47-4315-a6bc-d33a30f0cef6", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f486b2c9-fe72-4156-86e0-9193c329501d", "name": "The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. The client should not repeat this request without modification.", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e877b667-91d3-4ff1-b8d7-b21820d9b5c5", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f8d139e-a1fe-4bfb-bc3d-516ca52b16af", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3f04f41-9764-4b6d-b666-2e3967284b78", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "712f0b10-5495-4ca7-9a54-83e1f4de3698", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "68c6b5ff-6646-4867-9eca-c9bdddeb9108", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "search", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fieldName", "value": "" }, { "key": "substring", "value": "" }, { "key": "limit", "value": "10" }, { "key": "collection", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "6b14e6f0-0e36-4174-9c9e-88ee4d4e7700", "name": "files", "item": [ { "id": "d80f4f27-bf9b-4735-ab64-91c09a331743", "name": "Query files", "request": { "name": "Query files", "description": { "content": "Query files (files metatata) by different prarms (i.e. scope, id, filenames etc...)\nSorting and pagination supported using marker.\n\n- Logic between the filters : AND - i.e All conditions should be satisfied\n- Default sorting - Creation time ASC\n- Items per page: 30\n", "type": "text/plain" }, "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "A continuation token, used to retrieve the next results page.", "key": "marker", "value": "" }, { "description": "Filter files by id", "key": "ids", "value": "" }, { "description": "Filter files by id", "key": "ids", "value": "" }, { "description": "Filter files by status", "key": "status", "value": "" }, { "description": "Filter files by status", "key": "status", "value": "" }, { "description": "Filter files by fileName\nPartial filename can be provided. i.e. givven filename param = 'ample', the file 'sample.txt'\nwill be found assuming it exists in the system and all other filtes apply.\n", "key": "fileName", "value": "" }, { "description": "Filter files by entity scope type.\nThis filter is related to scopeId. i.e. if scopeType is provided then scopeId should be provided as well.\n", "key": "scopeType", "value": "" }, { "description": "Filter files by Entity scope ID. \ne.g. query files only associated with alert with ID 5a9e19eebdee5a000a8fe060.\nThis filter is related to scopeType. i.e. if scopeId is provided then scopeType should be provided as well.\n", "key": "scopeId", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "d7e075e9-06b1-40f5-9519-598adc8d8a51", "name": "A JSON object containing the results and additional information", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"status\": \"verified\",\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"name\": \"attachment.txt\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"url\": \"https://someDomain/somePath/attachment.txt\",\n \"size\": 2680000,\n \"mimeType\": \"text/plain\",\n \"createdAt\": \"1969-05-04T01:14:57.682Z\",\n \"createdBy\": \"8e2c4cf54b832e0018f191ad\",\n \"extension\": \"txt\",\n \"relations\": [\n {\n \"type\": \"vega\"\n }\n ]\n },\n {\n \"status\": \"ready\",\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"name\": \"attachment.txt\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"url\": \"https://someDomain/somePath/attachment.txt\",\n \"size\": 2680000,\n \"mimeType\": \"text/plain\",\n \"createdAt\": \"1983-02-07T05:46:45.083Z\",\n \"createdBy\": \"8e2c4cf54b832e0018f191ad\",\n \"extension\": \"txt\",\n \"relations\": [\n {\n \"type\": \"vega\"\n }\n ]\n }\n ],\n \"nextMarker\": \"magna pariatur ad\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8210bda-540a-4162-ad28-63c490810183", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c69fe762-5b27-456d-944d-9bd36f837ca0", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "457c8b32-45cc-4f53-a9a2-5c19744cd7a8", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4fbe45e8-d10c-4fb9-a2b7-441d32b14baa", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e06ea8b8-b31c-4c5f-8f8a-5fdbb5099db4", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39e7b5cd-45d4-4487-a676-fc96dd3256cc", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d55e121-97c1-4894-ac1f-f355ba621468", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67d44e88-a6f9-4ac2-bedb-8817215b4916", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "marker", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "status", "value": "" }, { "key": "status", "value": "" }, { "key": "fileName", "value": "" }, { "key": "scopeType", "value": "" }, { "key": "scopeId", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "f93ebaab-2cfb-4558-b1c5-133267b446cf", "name": "Upload a new file", "request": { "name": "Upload a new file", "description": { "content": "Securely upload a new file to CDC.\n\nMaximum file size = 12 Mb (12,582,912 bytes)\n", "type": "text/plain" }, "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "(Required) A unique, machine-oriented ID identifying this scope. must be provided together with scopeType. e.g. if scopeType = alert, then scopeId = [the alert ID]\n", "key": "scopeId", "value": "" }, { "description": "(Required) The type of the entity ( alert / incident / channel / visualization...)", "key": "scopeType", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "relations", "value": "", "type": "text", "description": "A string representing array of json object where type = relation type, e.g. vega and id = template file id." }, { "key": "password", "value": "", "type": "text", "description": "A single password or more separated by a comma." }, { "key": "file", "value": "", "type": "text", "description": "The binary file stream" } ] } }, "response": [ { "id": "b9d5f8c6-2f6e-4377-8e77-7555e5c7c38e", "name": "Listing information for the uploaded file", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"verified\",\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"name\": \"attachment.txt\",\n \"scope\": {\n \"id\": \"616ea579f2631c8d4c68a1b7\",\n \"type\": \"alert\"\n },\n \"url\": \"https://someDomain/somePath/attachment.txt\",\n \"size\": 2680000,\n \"mimeType\": \"text/plain\",\n \"createdAt\": \"1998-11-22T07:42:50.412Z\",\n \"createdBy\": \"8e2c4cf54b832e0018f191ad\",\n \"extension\": \"txt\",\n \"relations\": [\n {\n \"id\": \"eu aute\",\n \"type\": \"vega\"\n },\n {\n \"id\": \"do ut irure\",\n \"type\": \"vega\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c94d6b3-b3d3-4ce1-b0b6-fc41d78c72e8", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c7127b3-a199-463e-a822-e61ab2d5070c", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf1f7b06-0117-42d6-8c13-bd8f46dfd09f", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73b469fa-c57d-4d93-a790-422b5062cb62", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52d94123-27b5-45cc-a98d-7c86ac7994ec", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72765d18-2231-4bed-82e8-b0d6a0568711", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fffddbbd-3184-4f1e-baca-6f5638e48389", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "622cb607-af60-4488-ac60-6e32ff7e049a", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32f21822-009d-448b-8959-014948454426", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "files", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scopeId", "value": "5e7c6cf54b832e0018f191ad" }, { "key": "scopeType", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "A string representing array of json object where type = relation type, e.g. vega and id = template file id.", "type": "text/plain" }, "key": "relations", "value": "[{\"type\": \"vega\", \"id\": \"5e7c6cf54b832e0018f191ad\"}]", "type": "text" }, { "description": { "content": "A single password or more separated by a comma.", "type": "text/plain" }, "key": "password", "value": "test123", "type": "text" }, { "description": { "content": "The binary file stream", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "9ef208ff-7bff-432d-8288-760acef96b9a", "name": "Download a file", "request": { "name": "Download a file", "description": { "content": "Download a file by id\n\nErrors: \n - File is still uploading - Expected error code 409 (Conflict)\n - File had malicious content so it is not avaliable - Expected error code 410 (Gone)\n", "type": "text/plain" }, "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "Download thumbnail image if exists\nA thumbnail is a small image representation of a larger image or a video.\n", "key": "thumbnail", "value": "" } ], "variable": [ { "description": "(Required) A unique, machine-oriented ID identifying this file.", "type": "any", "value": "", "key": "fileId" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "161adcee-fc0f-44d4-be2f-177e28077df7", "name": "Binary file stream with file contents", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "reprehenderit exercitation ven", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89c09513-ec10-4ec7-bf3d-cab5d6fbdc6b", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cae33f96-810c-4023-a896-8a693911e06e", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8eba317c-cbf7-46b7-b4e0-ae7bb1926b48", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f94a87a-732f-41f4-888d-13f4e9fffb33", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89905a8c-e232-4487-9075-9fee60ff67b0", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd5cb104-2dd2-455c-8941-721da5c1704c", "name": "The resource requested is no longer available and will not be available again. The resource could have been intentionally removed and should be purged. The client should not request the resource in the future.", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90a343fa-354e-4289-9e10-38bd795207a5", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f747127f-e771-4507-8548-dadc3032397c", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "317f6781-4da3-47f9-9930-a681481596db", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44955bee-1f03-4a90-8c98-09f4cf468fd6", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "68fd1dca-302e-46c0-88f0-2f8fe13cfe28", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3fad8928-b6d8-41d8-b92f-1c86a3df520d", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "files", ":fileId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "thumbnail", "value": "false" }, { "key": "apiKey", "value": "" } ], "variable": [ { "type": "any", "key": "fileId" } ] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "eeeafa8a-c8f3-40d2-8edc-22cb44381f9e", "name": "grouping", "item": [ { "id": "9838ee4d-f3dd-4160-9969-b0a23c6baf7b", "name": "Returns grouping settings", "request": { "name": "Returns grouping settings", "description": { "content": "**NOTE:** To access Grouping Settings, user should have specific Admin privileges.\n", "type": "text/plain" }, "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "dc1d2171-fd58-4598-8348-e63f036c80bd", "name": "success", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"incidentTimeLimit\": 86400000,\n \"maxAlertsPerIncident\": 150\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf325074-29ab-4e9a-93c1-c162bb191b4b", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfd51db8-b3bd-4bf3-a489-cc5cd87d0a75", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "235a2a6e-a1d2-4dd1-8f56-159b72d3910b", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2e39090-9cdc-4e48-95b5-43f407d7341f", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97d5e924-3c35-4972-8a9e-b372dcae5611", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58477471-212c-4300-a8d2-27b956cf99c1", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "805e372e-0021-45c5-905f-6d8d50166a2a", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6ae1959-1e92-4493-a7ee-cc6386d44cd3", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56163869-9d3c-46d4-ba93-faadcffdba00", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "grouping", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "f2d58a0c-a165-4ca5-9b36-442ef6a14f39", "name": "Returns a full list of grouping settings", "request": { "name": "Returns a full list of grouping settings", "description": { "content": "**NOTE:** To access Grouping Rules, user should have specific Admin privileges\n", "type": "text/plain" }, "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "38ddb990-9b7a-4cee-8185-d902036934e7", "name": "success", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"title\": \"PhishingRule\",\n \"order\": 1,\n \"enabled\": true,\n \"criteria\": [\n {\n \"fieldName\": \"observables\",\n \"operator\": \"allOf\",\n \"matchValue\": \"schema type not provided\"\n },\n {\n \"fieldName\": \"observables\",\n \"operator\": \"allOf\",\n \"matchValue\": \"schema type not provided\"\n }\n ],\n \"comment\": \"5e7c6cf54b832e0018f191ad\",\n \"ruleTimeLimit\": 86400000\n },\n {\n \"id\": \"5e7c6cf54b832e0018f191ad\",\n \"title\": \"PhishingRule\",\n \"order\": 1,\n \"enabled\": true,\n \"criteria\": [\n {\n \"fieldName\": \"observables\",\n \"operator\": \"allOf\",\n \"matchValue\": \"schema type not provided\"\n },\n {\n \"fieldName\": \"observables\",\n \"operator\": \"allOf\",\n \"matchValue\": \"schema type not provided\"\n }\n ],\n \"comment\": \"5e7c6cf54b832e0018f191ad\",\n \"ruleTimeLimit\": 86400000\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "862e9a92-a980-41a7-b4a3-66445ea0db24", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4120ad75-f899-470e-ac12-5bdb02d48f8e", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17bb5f5d-6661-4cca-9a52-33aeec94130c", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d1c3a20-0b57-4843-abbf-1c9646586079", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb2bf2ed-9e03-4144-9722-22b80c5a6f08", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46a5f2ff-f638-48e6-9c0d-9f6858c8a241", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fadfa8e4-8abe-4367-8ef2-a026dff7dab2", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b3084e4-13dc-4d90-a4b5-99c3a1967202", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95faf0c4-0ffc-4a7a-bd67-847677897a33", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "grouping", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [] }, { "id": "507a0366-4402-4bdd-a978-4dbabf66cb19", "name": "Read custom fields setting/schemas", "request": { "name": "Read custom fields setting/schemas", "description": { "content": "Query custom fields schema with support for filters and pagination", "type": "text/plain" }, "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "fields to sort by", "key": "sort", "value": "" }, { "description": "fields to sort by", "key": "sort", "value": "" }, { "description": "include total count on response (slower)", "key": "includeTotal", "value": "" }, { "description": "List of the db`s document identifiers", "key": "ids", "value": "" }, { "description": "List of the db`s document identifiers", "key": "ids", "value": "" }, { "description": "Enum values for the available data types i.e TEXT, RICH_TEXT, NUMBER etc.", "key": "type", "value": "" }, { "description": "Enum values for the available scopes i.e SUMMARY, ADDITIONAL_INFO etc.", "key": "scope", "value": "" }, { "description": "", "key": "marker", "value": "" }, { "description": "", "key": "label", "value": "" }, { "description": "", "key": "fieldName", "value": "" }, { "description": "", "key": "entityType", "value": "" }, { "description": "", "key": "classifications", "value": "" }, { "description": "", "key": "classifications", "value": "" }, { "description": "", "key": "visible", "value": "" }, { "description": "", "key": "order", "value": "" }, { "description": "", "key": "deleted", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "4c752523-931e-4102-ba72-85d26f12e8fa", "name": "Response for query schema", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 10507350.541325927,\n \"results\": [\n {\n \"id\": \"eu incididunt in laborum\",\n \"label\": \"dolore deserunt veniam\",\n \"fieldName\": \"Duis elit enim nostrud amet\",\n \"entityType\": \"INCIDENT\",\n \"classifications\": [\n \"consectetur culpa\",\n \"non adipisicing tempor\"\n ],\n \"type\": \"\",\n \"scope\": \"\",\n \"createdAt\": \"1956-02-29T01:19:40.287Z\",\n \"updatedAt\": \"2002-08-17T07:16:53.404Z\",\n \"order\": 87307713.0793382,\n \"visible\": true,\n \"deleted\": false\n },\n {\n \"id\": \"dolore\",\n \"label\": \"amet aliquip\",\n \"fieldName\": \"non tempor\",\n \"entityType\": \"ALERT\",\n \"classifications\": [\n \"aliquip aute eu ad\",\n \"in ex\"\n ],\n \"type\": \"\",\n \"scope\": \"\",\n \"createdAt\": \"1995-08-27T13:09:46.151Z\",\n \"updatedAt\": \"2005-11-11T00:23:21.349Z\",\n \"order\": -93228472.27955973,\n \"visible\": false,\n \"deleted\": false\n }\n ],\n \"nextMarker\": \"sit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f05fe2b4-78b9-4073-bbb2-fc790ddf191f", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6aa724d5-457b-41c7-b0ee-d1e6a7f73c47", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36bd0191-f48c-48aa-a148-3591a997d523", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c04fb014-8146-4c94-abf5-c4a826d23a0a", "name": "The requested resource was not found", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "145b81ab-5792-49fe-91af-38d24d0911ac", "name": "The request conflicts with the current state of the resource.", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3976f40-7939-458e-b323-bdfa79ee660d", "name": "The resource requested is no longer available and will not be available again. The resource could have been intentionally removed and should be purged. The client should not request the resource in the future.", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "173cff38-da29-4628-a7ab-d779c1a50139", "name": "The payload sent by the client exceeds the size limits imposed by the server", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "281ffbb6-0a8f-4692-a418-d7891eecdffd", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb29e60b-a538-4882-8610-f4b4e3b321d1", "name": "The server encountered an unexpected condition that prevented it from fulfilling the request", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c456b9b-82a9-4223-b0c4-5a6fdf7fbd34", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14581e30-e4fe-452f-a390-e389f39c076d", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "867d0603-5745-4628-af2a-cb5df6ff0299", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "custom-fields", "settings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "" }, { "key": "sort", "value": "" }, { "key": "includeTotal", "value": "" }, { "key": "ids", "value": "" }, { "key": "ids", "value": "" }, { "key": "type", "value": "" }, { "key": "scope", "value": "" }, { "key": "marker", "value": "" }, { "key": "label", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "entityType", "value": "" }, { "key": "classifications", "value": "" }, { "key": "classifications", "value": "" }, { "key": "visible", "value": "" }, { "key": "order", "value": "" }, { "key": "deleted", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] }, { "id": "5b301714-e188-44b6-ae5f-47565e3811f6", "name": "QueryMetamodels metamodels by model and fieldName", "request": { "name": "QueryMetamodels metamodels by model and fieldName", "description": { "content": "Returns metamodels", "type": "text/plain" }, "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "description": "", "key": "model", "value": "" }, { "description": "", "key": "fieldName", "value": "" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "0f29db92-b81f-41f2-bc8f-54037fbf7617", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"in veniam nostrud esse\",\n \"availableValues\": [\n {\n \"value\": \"do dolore in laborum\",\n \"color\": \"officia ad minim velit adipisicing\",\n \"readOnly\": false,\n \"order\": -74345782.6014049\n },\n {\n \"value\": \"ea nulla enim\",\n \"color\": \"do nulla magna\",\n \"readOnly\": true,\n \"order\": 69767579.82677224\n }\n ],\n \"model\": \"et Lorem\",\n \"fieldName\": \"do cupidatat\",\n \"created\": \"1973-11-06T17:13:55.779Z\",\n \"modified\": \"1973-12-09T03:09:03.374Z\",\n \"defaultValue\": \"ea proident non\",\n \"readOnly\": false\n },\n {\n \"id\": \"con\",\n \"availableValues\": [\n {\n \"value\": \"occaecat Ut non aliquip officia\",\n \"color\": \"dolore sint\",\n \"readOnly\": false,\n \"order\": -28350161.31436619\n },\n {\n \"value\": \"L\",\n \"color\": \"ad aliquip nisi sed\",\n \"readOnly\": true,\n \"order\": -53868853.84346604\n }\n ],\n \"model\": \"et non\",\n \"fieldName\": \"amet eu\",\n \"created\": \"1948-03-27T12:25:21.780Z\",\n \"modified\": \"1996-02-15T14:16:44.223Z\",\n \"defaultValue\": \"esse in\",\n \"readOnly\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "886e0066-ce41-4a38-b2f6-a14e7a3338df", "name": "The request is invalid", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e38ad8e9-6230-48f7-9c0d-d5abfeaad841", "name": "Authentication failure", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bbc754f8-b534-46e3-8797-28f896bebb1a", "name": "The client does not have sufficient priviliges to access the requested resource or perform the requested operation", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13629eee-03bd-4bdf-aeb6-e00b7786b51b", "name": "Too many requests (throttled). The client should backoff and retry later on, in accordance to the rate limiting policy of the server.", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4228091c-7e1f-455a-8a15-9b177014bcaa", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2430699d-8e13-407c-81a6-de6ffb82fda1", "name": "The API server, acting as a gateway, got an invalid response from the underlying data store", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fc5e2848-0fbd-43b1-afe4-1463ed76749c", "name": "The server cannot handle the request at the moment", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0868313-aa99-4d00-bfa3-c2ad3043daab", "name": "The API server, acting as a gateway, could not get a response from the underlying data store in due time", "originalRequest": { "url": { "path": [ "metamoteds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "model", "value": "" }, { "key": "fieldName", "value": "" }, { "key": "apiKey", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [] } ], "event": [], "variable": [ { "id": "baseUrl", "type": "string", "value": "https://test-api.cyberproof.io/api/v1" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "apiKey" }, { "key": "value", "value": true }, { "key": "in", "value": "query" } ] }, "info": { "_postman_id": "6a2d7810-34e9-49a3-8579-613cee2256fc", "name": "CyberProof Platform API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The CyberProof Platform public API, enabling integration with customer systems.\n\nContact Support:\n Name: CyberProof API Support\n Email: support@cyberproof.com", "type": "text/plain" } } }