{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"745d682f-3337-4bba-842f-c040b1ebb6e1","name":"iboss API","description":"# iboss API\n\nThe iboss API provides programmatic access to the iboss Zero Trust SSE platform, allowing administrators to manage security policies, gateway configurations, users, reporting, and more.\n\n## Base URLs\n\nAll API requests use environment variables for the base domains:\n\n| Variable | Description |\n| --- | --- |\n| `{{baseApiDomain}}` | Primary cloud API domain |\n| `{{gatewayNodeApiDomain}}` | Gateway node API domain |\n| `{{reportingNodeApiDomain}}` | Reporting node API domain |\n| `{{browserIsolationNodeApiDomain}}` | Browser isolation node API domain |\n\n## Authentication\n\nThe iboss API supports two authentication methods. Run the requests in the **Authentication - API Key** folder in order to obtain the required session tokens before calling other endpoints.\n\n### API Key Authentication (Recommended)\n\nUse this method when your account is configured with API keys. Run the following requests in sequence:\n\n1. **Get Primary Account ID** — Retrieves your `accountSettingsId` and stores it in the environment.\n    \n2. **Get API Base Domains** — Retrieves the correct base domain URLs for your account.\n    \n3. **Get Reporter Session ID** — Obtains a session token for the reporting node.\n    \n\nAll subsequent requests use the `token` environment variable populated during this flow.\n\n### Legacy Login (Session-Based)\n\nUse this method when your account is **not** configured to use API keys. This method authenticates using a username and password via HTTP Basic Auth.\n\n**Request:** `GET https://{{ibossAccounts}}/ibossauth/web/tokens`\n\nSet the following environment variables before running:\n\n| Variable | Description |\n| --- | --- |\n| `auth_username` | Your iboss administrator username |\n| `auth_password` | Your iboss administrator password |\n| `auth_mfa` | Your TOTP/MFA code (leave blank if MFA is not enabled) |\n\nOn success, the response token is automatically saved to the `token` environment variable and used by all subsequent requests.\n\n## API Endpoint Host\n\nThe domain, or host, that the API request is targetted to depends on the library being accessed. This is due to the highly distributed nature of the iboss Zero Trust SSE service. Each library of API calls are organized into folders. Each API library targets a specific part of the iboss platform and API requests are serviced by the node type that is responsible for that functional area. The primary node FQDN is used and will differ when interacting with the APIs for any library of API calls that are contained within a folder. The appropriate FQDN is automatically obtained when running all of the API calls within the \"Authentication\" folder as described in the Authentication section.\n\nThe following describes the FQDN used for each API library folder:\n\n1. Authentication API - Always uses \"accounts.ibosscloud.com\" for the FQDN of the API call.\n    \n2. Core API - Always uses\"api.ibosscloud.com\" for the FQDN of the API call.\n    \n3. Gateway API - Uses the FQDN of the primary gateway node of the default node cluster within the account.\n    \n4. Reporting API - Uses the FQDN of the primary reporting node of the default node cluster within the account.\n    \n5. Browser Isolation API - Always uses \"api.ibosscloud.com\".\n    \n\nYou can find the FQDN of the primary nodes using the \"Get API Base Domains\" API under the \"Authentication\" folder or by logging into the iboss admin console and navigating to \"Cloud Health->Node Collection Management\". If using the \"Get API Base Domains\" API call, the FQDN of all primary nodes are automatically captured and stored in the \"iboss API Environment\" variables.\n\nWhen making API requests within a specific library folder, make sure to use the correct FQDN for the API based on the mapping described above.\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n## Rate and usage limits\n\nThe iboss Zero Trust SSE API is not currently rate-limited. Due to the highly distributed and containerized architecture, the iboss platform is capable of handling a large number of API requests without interrupting capabilities. However, unnecessarily high volumes of API requests can be throttled or cut if deemed abusive.\n\n## Environment Setup\n\nImport the **iboss API Environment** and fill in the required variables for your account before making any requests.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"26524233","team":4855528,"collectionId":"745d682f-3337-4bba-842f-c040b1ebb6e1","publishedId":"2s93RUuXjk","public":true,"publicUrl":"https://documenter-api.postman.tech/view/26524233/2s93RUuXjk","privateUrl":"https://go.postman.co/documentation/26524233-745d682f-3337-4bba-842f-c040b1ebb6e1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"iboss Zero Trust SSE"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.0","publishDate":"2023-05-16T22:00:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"iboss Zero Trust SSE","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"iboss API Environment","id":"b2368d33-00a1-4aa3-9769-70b1318a7b6c","owner":"26742614","values":[{"key":"auth_username","value":"","enabled":true,"type":"default"},{"key":"auth_password","value":"","enabled":true,"type":"secret"},{"key":"auth_mfa","value":"","enabled":true,"type":"secret"},{"key":"token","value":"example-token","enabled":true,"type":"default"},{"key":"accountSettingsId","value":"example-account-settings-id","enabled":true,"type":"default"},{"key":"baseApiDomain","value":"api.ibosscloud.com","enabled":true,"type":"default"},{"key":"gatewayNodeApiDomain","value":"example-gateway-node-api-domain","enabled":true,"type":"default"},{"key":"reportingNodeApiDomain","value":"example-reporting-node-api-domain","enabled":true,"type":"default"},{"key":"browserIsolationNodeApiDomain","value":"example-browser-isolation-node-api-domain","enabled":true,"type":"default"},{"key":"cloudXsrfToken","value":"example-cloud-xsrf-token","enabled":true,"type":"default"},{"key":"cloudSessionId","value":"example-cloud-session-id","enabled":true,"type":"default"},{"key":"reporterSessionId","value":"example-reporter-session-id","enabled":true,"type":"default"},{"key":"reporterXsrfToken","value":"example-reporter-xsrf-token","enabled":true,"type":"default"},{"key":"ibossAccounts","value":"accounts.iboss.com","enabled":true,"type":"default"},{"key":"selective_ssl_decryption_application_id","value":"example-selective-ssl-decryption-application-id","enabled":true,"type":"default"},{"key":"selective_ssl_decryption_application_uuid","value":"example-selective-ssl-decryption-application-uuid","enabled":true,"type":"default"}],"published":true}],"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/b781c2a79b1530197712de0e74c510a8d650b82c96d255c812590c2683d39a6b","favicon":""},"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"},{"label":"iboss API Environment","value":"26742614-b2368d33-00a1-4aa3-9769-70b1318a7b6c"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93RUuXjk"}