{"id":"568bdc1483d2061900d86cdc","name":"droplit.io","subdomain":"droplit","versions":[{"_id":"582789aabe5c080f00a5a7fe","releaseDate":"2016-11-12T21:29:14.915Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"beta2","version_clean":"0.1.0","version":"0.1"},{"_id":"58cb3c54fab9ac0f00b8b908","releaseDate":"2017-03-17T01:31:00.504Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"beta3","version_clean":"0.15.0","version":"0.15"},{"_id":"59a72290d61777001b6c42c3","releaseDate":"2017-08-30T20:39:44.453Z","is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"}],"current_version":{"version_clean":"0.0.0","version":"0"},"oauth":{"enabled":false},"api":{"name":"","url":"https://ioe.droplit.io/v:version","contenttype":"json","auth":"token","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[{"_id":"568bde36e3e30f0d0021e081","type":"header","default":"","key":"authorization"}],"headers":[],"object_definitions":[]},"apiAlt":[{"_id":"59a733a3757d030019b85ad4","object_definitions":[],"headers":[],"authextra":[{"_id":"59a73422c6cb7d001b12ca74","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/account","name":"Account API"},{"_id":"59a736f6c6cb7d001b12ca9e","object_definitions":[],"headers":[],"authextra":[{"_id":"59a7378a757d030019b85b7f","type":"header","default":"","key":"x-authentication"},{"_id":"59a7378a757d030019b85b7e","type":"header","default":"","key":"x-environment"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/direct","name":"Direct API"},{"_id":"59a74f2dcce3a7002729229b","object_definitions":[],"headers":[],"authextra":[{"_id":"59a74f99757d030019b85e62","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/clients","name":"Clients API"},{"_id":"59a750fbd61777001b6c47ed","object_definitions":[],"headers":[],"authextra":[{"_id":"59a751473fe4d900251181ed","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/devices","name":"Devices API"},{"_id":"59a75f6e757d030019b85f83","object_definitions":[],"headers":[],"authextra":[{"_id":"59a75fb739e18b000f20ae48","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/environments","name":"Environments API"},{"_id":"59a75ffc4836990031f5ec2f","object_definitions":[],"headers":[],"authextra":[{"_id":"59a7604239e18b000f20ae4a","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/ecosystems","name":"Ecosystems API"},{"_id":"59a760e7958d02000f67771f","object_definitions":[],"headers":[],"authextra":[{"_id":"59a7612b4836990031f5ec32","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/schemas","name":"Schemas API"},{"_id":"59a76194958d02000f677741","object_definitions":[],"headers":[],"authextra":[{"_id":"59a761da457bb00025cc26ef","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/serviceclasses","name":"Service Classes API"},{"_id":"59a85b6b02c545000f08a77f","object_definitions":[],"headers":[],"authextra":[{"_id":"59a85baec191c6000f3d3c6a","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/users","name":"Users API"},{"_id":"59a85bd52bdf3600193d4fd5","object_definitions":[],"headers":[],"authextra":[{"_id":"59a85c0ac191c6000f3d3ca8","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/webhooks","name":"Webhooks API"},{"_id":"59a85c5502c545000f08a7a5","object_definitions":[],"headers":[],"authextra":[{"_id":"59a85c8ccb1d3b000f33a126","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/zones","name":"Zones API"},{"_id":"59f773da3624640026dc9e8e","object_definitions":[],"headers":[],"authextra":[{"_id":"59f77420814c2200265b668a","type":"header","default":"","key":"authorization"}],"jwt":false,"proxyEnabled":true,"explorer":true,"auth":"token","contenttype":"json","url":"https://ioe.droplit.io/v:version/api/conduits","name":"Conduits API"}],"plan_details":{"name":"Developer Hub","is_active":true,"cost":59,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":false,"errors":false,"password":true,"landing_page":true,"themebuilder":true,"stylesheet":true,"javascript":false,"html":true,"extra_html":false,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":true,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"newApiExplorer":false,"autoSslGeneration":true},"asset_base_url":""}

{"_id":"5b5b59afd8add30003eecd0c","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c7e975c50cf30010d712a0","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-24T17:20:53.835Z","from_sync":false,"order":27,"slug":"zones-api","title":"Zones API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":10,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-27T17:43:11.452Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"59a85c5502c545000f08a7a5","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"items\": [\n        {\n            \"id\": \"Z59936c379caafb48287a2314\",\n            \"environmentId\": \"E59b342bc9a0a6159691dcda1\",\n            \"ecosystemId\": \"C592349aeacacfb98217ab196\",\n            \"alias\": \"demo_zone\",\n            \"meta\": {\n                \"$label\": \"Demo Zone\"\n            },\n            \"createdAt\": \"2017-06-16T04:53:11.696Z\"\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"environmentId\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}","name":"Environment Invalid"},{"code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"query\",\n            \"message\": \"Invalid input 'invalid' from filter 'invalid'. Expected 'AND','OR','NOR','NOT','EQUALS','NOTEQUALS','LESSTHAN','LESSTHANOREQUAL','GREATERTHAN','GREATERTHANOREQUAL','IN','NOTIN','TYPE','EXISTS','NOTEXISTS','CONTAINS','NCONTAINS' after ''\"\n        }\n    ]\n}","language":"json","name":"Filter Invalid","status":400},{"code":"Environment with id E599342bcea0961a9651dbda1 does not exist.","language":"text","name":"Environment Not Found","status":404}]},"examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/zones/?environmentId=E59b342bc9a0a6159691dcda1&filter=eq(alias, \"demo_zone\") HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"Console","language":"text","code":"droplit zone list --environmentId E59b342bc9a0a6159691dcda1"},{"code":"droplit.zones.list(\"E59b342bc9a0a6159691dcda1\", 'eq(alias, \"demo_zone\")');","language":"javascript","name":"Droplit SDK"}]},"method":"get","auth":"required","params":[{"_id":"59c7e9e2791ca600105b98b8","ref":"","in":"query","required":true,"desc":"The ID of the desired environment.","default":"","type":"string","name":"environmentId"},{"_id":"5b5b5a4ab22ba300037b3f3d","ref":"","in":"query","required":false,"desc":"Get only zones whose properties fulfill the conditions of a [filter](doc:filters).","default":"","type":"string","name":"filter"},{"_id":"5b5b5a81b22ba300037b3f3f","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"}],"url":"/"},"isReference":false,"order":0,"body":"An account token, server token, or user token may be used to run this endpoint.","excerpt":"Get all the zones in an environment.","slug":"zones-list","type":"endpoint","title":"List zones."}

getList zones.

Get all the zones in an environment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

environmentId:

required

string

The ID of the desired environment.

filter:

string

Get only zones whose properties fulfill the conditions of a [filter](doc:filters).

Headers

authorization:

required

string

The user's authorization token.

Examples

Result Format

Documentation

An account token, server token, or user token may be used to run this endpoint.

Try It Out

{{ param.name }}*

get

{{ tryResults.results }}

Method	{{ tryResults.method }}
Request Headers	{{ tryResults.requestHeaders }}
URL	{{ tryResults.url }}
Request Data	{{ tryResults.data }}
Status
Response Headers	{{ tryResults.responseHeaders }}