{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","description":"The NetBeez API allows dashboard administrators the ability to integrate NetBeez with other solutions such as tools, reporting & analytics solutions, and more. This documentation outlines available APIs that can be used along with available options and examples.\n\nContact support for any questions you may have.\n\n# Authentication\n\nAll requests to the NetBeez API must be authenticated using an API key. This key is passed via HTTP headers on every request.\n\n## Generating an API Key\n\nNetBeez Administrators can create an API key from the NetBeez Dashboard:\n\n1. Navigate to Settings by clicking the cog icon located in the menu bar.\n2. Click on \"API Keys\" located in the left settings menu.\n3. Click the \"Generate API Key\" button and fill out the form.\n\n## Required Headers\n\nEvery authenticated request must include the following headers:\n\n| Header | Value | Description |\n|---|---|---|\n| `Authorization` | `Bearer <your_api_key>` | Your generated API key, prefixed with `Bearer`. This header is required for all API requests. |\n| `Content-Type` | `application/json` | Indicates that the request body (if any) is in JSON format. |\n| `Cache-Control` | `no-store` | Ensures responses are not cached. |\n\n### Example\n\n```\nAuthorization: Bearer abc123def456\nContent-Type: application/json\nCache-Control: no-store\n```\n\nMake sure to replace `abc123def456` with your actual API key. If the `Authorization` header is missing or contains an invalid key, the API will return a `401 Unauthorized` response.\n\n# Using Postman\n\nWe want to make exploring and utilizing our API easier for our customers. This is why we now provide our customers with a Postman project that can be downloaded onto your computer. This allows you to test out available APIs and can help you integrate NetBeez into your IT infrastructure.\n\nDownload the project by clicking the \"Run in Postman\" button at the top of the page. Our Postman project uses variables to set the FQDN and API Key to your NetBeez Dashboard across all API calls in the project. To make it easier to use Postman for your NetBeez installation you can set up an environment for NetBeez. To learn how to do this [watch this video](https://www.youtube.com/watch?v=wArvaHYdw2I) from Postman. Add the following variables to your environment:\n\n- `HOSTNAME`: Set this to the FQDN of your NetBeez Dashboard.\n- `API_KEY`: Set this to a generated API Key. See the above Authentication section for more information.\n    \n\n# Future API Changes (Version 13.0+)\n\nWe are implementing changes, starting in version 13.0, which will affect future versions of the API. These changes will go into effect for all new API changes we release and will be backward compatible with existing APIs for 2 versions after deprecation notices have been announced.\n\n1. `POST` and `PUT` will be standardized into the same request format (JSONAPI) that we use for `GET` requests. This is to help streamline API consumption and also provide a very important update to how we manage relationships of data resources.\n    \n    1. With these changes, the API will allow for [upserting and removal of relationships](#folder-670b7e0c-98e4-44b6-9875-96233d01330b), which means consumers of the API will no longer have to provide all relationship information when updating dependent data resources. See the reference section for more details.\n        \n2. Some endpoints include supplemental relationship data by default and that will no longer be the case going forward. This is to help reduce payload sizes in situations where included relationship data isn't needed by consumers of the API.\n    1. Consumers of the API can still retrieve the relationship data, however, it will need to be specifically requested from the available options of an API call. For example, [GET /agents](#request-4425180-f0ffc514-ddbd-45ef-ac52-fe08a86de944) currently automatically includes `network_interface` information, and once updated with this change the API calls will need to specifically request `network_interface` information using `include=network_interface` query parameter.\n\n# Latest Version: 14.1\n\nSee the [changelog](#folder-4425180-057dfa24-071c-4d68-aaf5-df01e3cb302c) for changes for the latest version of NetBeez.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4425180","team":178556,"collectionId":"2497eaca-6106-40b1-acac-7366b290def4","publishedId":"SWTEbvow","public":true,"publicUrl":"https://api.netbeez.net","privateUrl":"https://go.postman.co/documentation/4425180-2497eaca-6106-40b1-acac-7366b290def4","customColor":{"top-bar":"FFFFFF","right-sidebar":"444444","highlight":"000000"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-02-18T19:49:30.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/cc8ef416f1bb04b13b1a3c8908d27b0773306a72a4cd6a101d1b4e3a91ede366","favicon":"https://netbeez.net/favicon.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://api.netbeez.net/view/metadata/SWTEbvow"}