{"_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.

User Information

Try It Out

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