{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bf3747fc-4030-8316-a734-ae7a339ffadc","name":"HostedZone Published API","description":"# Authorization\n\nPublished API services are available to environments which have the **ADMIN** right for the **hosted_zone_api** service in the **environment-global** zone. Administrators can grant these rights to an environment using the Broker Manager UI.\n\n# Authentication\n\nAuthorized environments authenticate using standard SIF3.x Basic Authentication or SIF_HMACSHA256 authentication methods.\n\n> CedarLabs strongly recommend using SIF_HMACSHA256 authentication for environments using the HostedZone API. For the purposes of the examples given in the documentation BASIC auth is used as the samples are in a sandboxed environment. \n  \n\n# APIs\n\n## [Create environments in batch](#c9f37316-765d-921c-bab8-8381f96b55bb)\n\nThis API allows up to 100 environments to be created in a single request.\n\n## [Update environments in batch](#42f2a4cf-5bba-bb43-69a0-3b63ac46bf55)\n\nThis API allows up to 100 environments to be updated in a single request.\n\n## [Retrieve environments](#f6a93ef2-7ac5-4721-9b3e-d62b0b60fcc3)\n\nThis API allows all solution environments to be retrieved.\n\n## [Unlock environments](#8640d085-9fc5-4eb0-9d2e-0caa1e136c8d)\n\nThis API allows environments to be unlock in batch.\n\n## [Update endpoints in batch](#95774c19-abac-4868-af29-dbbf54d1e271)\n\nThis API allows provider endpoints and environment `defaultProviderUrls` to be updated in batch.\n\n## [Create Zones From Template](#8158fb1f-0276-4ee3-bb36-e64056fe5df9)\n\nThis API allows multiple zones to be created from a single _template_ zone.\n\n## [Retrieve Queues (pending v.1.6.4.19a)](#8dbdebcb-c498-489e-ae95-dc74ce17d36a)\n\nThis API allows all of the solution's queues to be retrieved.\n\n# Setup\n\nThe examples in this documentation use a sandbox domain: **api-documentation** and solution: **hostedZonePublishedAPI**. The solution contains a number of zones and services used to illustrate the API capabilities. The setup is as follows:\n\n## Services\n\n- **Domain**: api-documentation\n    - **Solution**: hostedZonePublishedAPI\n        - **Zone**: DEFAULT\n            - **Context**: DEFAULT\n                - **Service**: Students\n                    \n        - **Zone**: zone1\n            - **Context**: DEFAULT\n                \n            - **Context**: zone1Context\n                - **Service**: staffs\n                    \n\n## Environments\n\nAn environment with **ADMIN** rights on the **hosted_zone_api** in the **environment-global** zone is created.\n\n## Queues\n\nA queue with owned by the above environment is created.\n\n# Running the examples\n\nThe examples in the API can be run either as raw cURL commands or in Postman using the \"Run in Postman\" button.\n\n> The examples are not idempotent and require that the solution be **reset** to produce the expected results. To reset the API solution you can execute the 2 REST calls [here](https://api-docs-reset.cedarlabs.com/) in either Postman or a command line client.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"514710","collectionId":"bf3747fc-4030-8316-a734-ae7a339ffadc","publishedId":"7TMAXRd","public":true,"publicUrl":"https://api-docs.cedarlabs.com","privateUrl":"https://go.postman.co/documentation/514710-bf3747fc-4030-8316-a734-ae7a339ffadc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-02-09T03:08:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Published API.template","id":"72853777-f92d-d5b4-3f63-9a235a19e067","owner":"514710","values":[{"enabled":true,"key":"APIDocs-Domain","value":"api-documentation","type":"text"},{"enabled":true,"key":"baseUrl","value":"https://api-documentation.hostedzone.com","type":"text"},{"enabled":true,"key":"APIDocs-Solution","value":"batchEnvironmentAPI","type":"text"},{"enabled":true,"key":"adminBasicAuthToken","value":"MDcwZDliYTItYzdkOC00Njc3LWJhMGItNjA0ZWQzMmYwNDI3OjE2Yml0c2hhcmVkc2VjcnQ=","type":"text"},{"enabled":true,"key":"encryptedPassword","value":"363109148969c792ff5202ae:11f6fdc37b7d74c7f98db92bc367a427973bc627c0a132f1a0de5694b2a3d12dc9","type":"text"},{"enabled":true,"key":"env1Id","value":"616ecbc6-a35e-4b91-8bd1-dbb3182f1fef","type":"text"},{"enabled":true,"key":"env2Id","value":"d4cfffee-ce87-4afb-bd55-71f24f6fd352","type":"text"},{"enabled":true,"key":"env3Id","value":"f497beff-869b-414e-9d88-bc53e9c51417","type":"text"}],"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":"https://cedarlabs.com/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"},{"label":"Published API.template","value":"514710-72853777-f92d-d5b4-3f63-9a235a19e067"}],"canonicalUrl":"https://api-docs.cedarlabs.com/view/metadata/7TMAXRd"}