{"_id":"59c7e9e2791ca600105b98b7","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"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"],"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":17,"slug":"zones-api","title":"Zones API"},"user":"58cc41f21751ce2f003be3b7","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-24T17:22:42.328Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a85c5502c545000f08a7a5","auth":"required","params":[{"_id":"59c7e9e2791ca600105b98b8","ref":"","in":"query","required":true,"desc":"","default":"","type":"string","name":"environmentId"}],"url":"/"},"isReference":false,"order":0,"body":"# Details\n\nList zones in an environment.\n\nAn account token, server token, or user token may be used to run this endpoint.\n\n# Parameters\n\n## query\n\n- environmentId (required): The ID of the environment.\n\n# Responses\n\n## 200\n\n```\n{\n    \"items\": [\n        {\n            \"alias\": \"ZONE-ALIAS\",\n            \"createdAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\",\n            \"ecosystemId\": \"ECOSYSTEM-ID\",\n            \"environmentId\": \"ENVIRONMENT-ID\",\n            \"id\": \"ZONE-ID\",\n            \"meta\": {}\n        }\n    ]\n}\n```\n\n## 400\n\n- __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment was not valid.\n- __Environment Missing:__ The standard error structure defines this error as invalid parameters. In this context, it means that the environment ID is missing, and was required.\n- __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint.\n\n## 404\n\n- __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/zones HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit zone list --environmentId ENVIRONMENT-ID\n```","excerpt":"","slug":"zones-list","type":"endpoint","title":"List zones in an environment."}

getList zones in an environment.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

environmentId:
required
string

Documentation

# Details List zones in an environment. An account token, server token, or user token may be used to run this endpoint. # Parameters ## query - environmentId (required): The ID of the environment. # Responses ## 200 ``` { "items": [ { "alias": "ZONE-ALIAS", "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED", "ecosystemId": "ECOSYSTEM-ID", "environmentId": "ENVIRONMENT-ID", "id": "ZONE-ID", "meta": {} } ] } ``` ## 400 - __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment was not valid. - __Environment Missing:__ The standard error structure defines this error as invalid parameters. In this context, it means that the environment ID is missing, and was required. - __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint. ## 404 - __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/zones HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit zone list --environmentId ENVIRONMENT-ID ```

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 }}