{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0352fd2d-90a6-4aa2-bf7a-ffd867cacf10","name":"Orka API","description":"The Orka API and SDK enable programmatic access to the Orka virtual machine management and orchestration tools. Additionally, MacStadium provides a [companion CLI](https://orkadocs.macstadium.com/docs/orka-cli), a web front end, and [several CI/CD plugins](https://orkadocs.macstadium.com/docs/downloads#section-cicd-integrations).\n\n## Administrative authentication\n\nAdministrative requests, such as creating users and resetting passwords, must contain the `orka-licensekey: <license>` header.\n\n## Token-based authentication\n\nNon-administrative requests require JWT-based authentication and must contain an `Authorization: Bearer <token>` header.\n\nCurrently, tokens do not expire. Administrators can revoke tokens.\n\n## Error codes\n\nError codes follow HTTP response code best practices but might include additional Orka-specific information.\n\n## Rate limit\n\nYou should not be able to reach the default rate limit during normal usage. If you need to make adjustments to your environment, please [contact us](https://portal.macstadium.com/).\n\n## macOS considerations\n\nOn macOS, be careful of the formatting for `\"` (quotation marks).\n\nSometimes, when you copy from the API documentation to the clipboard, quotation marks might be re-formatted to a different special character.\n\n## Service endpoint\n\nThe default Orka service endpoint (API URL) is usually `http://10.221.188.100` OR `http://10.10.10.100` OR a custom domain endpoint.\n\n> **How to find your Orka endpoint?**\n>\n> You can get the IP for your Orka endpoint from your [IP Plan](https://orkadocs.macstadium.com/docs/ip-plan). It's the `.100` address from your `Private-1` network. Usually, `10.221.188.100` or `10.10.10.100`. **You need to use `http://` with this service endpoint.**\n>\n> To get the custom domain for your Orka cluster (if enabled):\n> 1. Log into your [MacStadium account](https://portal.macstadium.com/).\n> 2. Go to **Subscriptions** (from the top right corner) and select your Orka cluster.\n> 3. In the **Subscription & Plan** details, find your custom domain at the bottom. If you don't see a custom domain field, it's not enabled for your environment yet. **You need to use `https://` with custom domains.**\n>\n>  You can use the IP service endpoint and your custom domain interchangeably.\n\n> **Using a custom domain?**\n>\n> If you're using OpenConnect to access your Orka cluster via VPN, you need to [add a DNS server](https://orkadocs.macstadium.com/docs/vpn-connect#configure-openconnect-to-access-orka-via-custom-domain) to your network configuration. \n>\n> If you're using Cisco AnyConnect on macOS or Linux, you're already set and you don't need to make any changes.\n>\n> If you're using Cisco AnyConnect on Windows, you need to [add a DNS server](https://orkadocs.macstadium.com/docs/vpn-connect#configure-anyconnect-to-access-orka-via-custom-domain) to your network configuration. ","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6574930","collectionId":"0352fd2d-90a6-4aa2-bf7a-ffd867cacf10","publishedId":"S1ETRGzt","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6574930/S1ETRGzt","privateUrl":"https://go.postman.co/documentation/6574930-0352fd2d-90a6-4aa2-bf7a-ffd867cacf10","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-04-19T20:04:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Orka","id":"eec7fecb-ed34-498a-8d5c-464a8d111d7c","owner":"6574930","values":[{"key":"email","value":"user@email.com","enabled":true},{"key":"password","value":"password","enabled":true},{"key":"domain","value":"http://10.221.188.100","enabled":true},{"key":"licenseKey","value":"myLicenseKey","enabled":true},{"key":"newPassword","value":"password1","enabled":true},{"key":"newEmail","value":"newUser@email.com","enabled":true},{"key":"vm","value":"myorkavm","enabled":true},{"key":"baseImage","value":"90GBVenturaSSH.img","enabled":true},{"key":"node","value":"macpro-1","enabled":true},{"key":"newNode","value":"macpro-2","enabled":true},{"key":"newBaseImage","value":"newVentura.img","enabled":true},{"key":"vmID","value":"05ca969973999","enabled":true},{"key":"storageImage","value":"myStorage.img","enabled":true},{"key":"apiVersion","value":"2.4.0","enabled":true},{"key":"kubeAccount","value":"mykubeuser","enabled":true},{"key":"iso","value":"Mojave.iso","enabled":true},{"key":"vmIP","value":"10.221.188.4","enabled":true},{"key":"count","value":"0","enabled":true},{"key":"group","value":"devteam1","enabled":true},{"key":"userGroup","value":"myUserGroup","enabled":true},{"key":"token","value":"myToken","enabled":true},{"key":"armBaseImage","value":"90GBVenturaSSH.orkasi","enabled":true,"type":"default"},{"key":"nodeTag","value":"myPool","enabled":true,"type":"default"},{"key":"logsStartDate","value":"2022-06-10T08:00:00Z","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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":"Orka","value":"6574930-eec7fecb-ed34-498a-8d5c-464a8d111d7c"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1ETRGzt"}