{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d137aeda-6380-49ba-9588-bdb932d9946e","name":"Lumu Defender API - Postman Tutorial","description":"<a href=\"https://lumu.io\">Lumu</a>\n\nis a cloud-based security technology that provides you with visibility into threats, attacks, and adversaries affecting your entire enterprise, across all your enterprise environments.\n\nTo get started with Lumu, visit [our documentation](https://docs.lumu.io/portal/en/home).\n\nThe **Lumu Defender API** offers a framework to help you leverage the Lumu integration with various third-party solutions.\n\nThe Lumu Defender API is based on HTTP requests and JSON responses and it is language agnostic and supports incoming and outgoing information. All API calls are encrypted using HTTPS (HTTP over SSL/TLS) and authenticated API key-based authentication.\n\n<img src=\"https://desk.zoho.com/DocsDisplay?zgId=694632768&amp;mode=inline&amp;blockId=k87ha1485ec187fca4b2c9e106e2c1af573f9\" alt=\"Lumu Defender API\">\n\n# What's in the collection?\n\nThe following resources are accessible via the Lumu Defender API. These are core concepts of Lumu Portal that you should familiarize yourself with.\n\n| Resource | Description |\n| --- | --- |\n| `administration` | For retrieving users and labels’ data. |\n| `incidents` | For subscribing, retrieving incident data, and managing their status. |\n| `adversarial-activity` | For retrieving all adversarial activity found on your perimeters. |\n| `spambox` | For retrieving the adversarial activity related to your Spambox. |\n| `Portal Management` | The Lumu Portal records the activities and configurations made on the Portal, allowing administrators to keep track of the changes and ensure compliance with your company’s policies. |\n\n> For in depth API specification, such as syntax, pagination, date format, error responses, rate limit and more, consult our documentation / support. \n  \n\n# Get started and support\n\n## Access and authentication\n\nThe Defender API requires each client to use a unique and personal API key, referred to in our documentation as `{company-key}`. The company’s API key is found in the Defender menu of the Lumu Portal and is self-managed by company administrators.\n\n<img src=\"https://desk.zoho.com/DocsDisplay?zgId=694632768&amp;mode=inline&amp;blockId=k87ha072189a6aaff40f39bbfd2acd23dd647\" alt=\"Lumu Defender API\">\n\n## Quick Setup\n\n[Postman](https://www.getpostman.com/) is a tool for exploring and testing APIs. This Postman collection, which is a group of API requests, contains a set of requests that provides you with Lumu Defender API endpoint requirements, request parameters, and response messages samples.\n\nClick the button **Run in Postman** to automatically open the Postman collection.\n\nOnce you've imported the collection to Postman, you will need to inform your company's API key from the Lumu Portal, for this, click in the collection, then go to the \"Variables\" (1) tab and add your company unique API key (2).\n\n<img src=\"https://desk.zoho.com/DocsDisplay?zgId=694632768&amp;mode=inline&amp;blockId=0nzsqc679f8d0e5bd49c8b2aaad5e5c469f74\" alt=\"Postman Setup\">\n\n## Tutorial Structure\n\nThe Postman collection is broken into four subfolders. They are organized in a way that introduces the Lumu resources that are available through the Lumu Defender API.\n\nEach folder and request in the collection has a description. Some of these descriptions contain important information, such as prerequisites for running the request or information that should be replaced with actual data to perform your query. After selecting the request in Postman, you can click the documentation icon to see the request details (1). Each request includes the query (2) and body parameters description (when applicable).\n\n<img src=\"https://desk.zoho.com/DocsDisplay?zgId=694632768&amp;mode=inline&amp;blockId=0nzsq5587eebdc76f4ee7945c09090f40a2a9\" alt=\"Postman Setup\">\n\nEach request includes a response example for the status 200 (1), you can see each sample inside the query, as in the following image:\n\n<img src=\"https://desk.zoho.com/DocsDisplay?zgId=694632768&amp;mode=inline&amp;blockId=0nzsq8d34d21159cc476eb427c81283b74fd6\" alt=\"Postman Setup\">\n\n_**NOTE**_: the examples of responses in this collection are not comprehensive of all parameter configurations or operations. The examples of responses intend to show the basic information provided by the API call, the format, and how that information is structured and labeled. The actual response can include more parameters.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"8464717","team":651537,"collectionId":"d137aeda-6380-49ba-9588-bdb932d9946e","publishedId":"TzRVfmh9","public":true,"publicUrl":"https://documenter-api.postman.tech/view/8464717/TzRVfmh9","privateUrl":"https://go.postman.co/documentation/8464717-d137aeda-6380-49ba-9588-bdb932d9946e","customColor":{"top-bar":"FFFFFF","right-sidebar":"333333","highlight":"f78e1e"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-05-14T15:23:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/653c8c3db6af62fdc73286ab8766069af4767b11267223dd6f23646d3a458357","favicon":"https://res.cloudinary.com/postman/image/upload/v1621005267/team/wdoqbvpdjhhejp2rdgoa.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TzRVfmh9"}