{"_id":"582789abbe5c080f00a5a845","user":"573b7f42fdc9d320001b777d","__v":1,"project":"568bdc1483d2061900d86cdc","category":{"_id":"582789abbe5c080f00a5a804","__v":0,"project":"568bdc1483d2061900d86cdc","version":"582789aabe5c080f00a5a7fe","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:30:25.315Z","from_sync":false,"order":16,"slug":"zones","title":"Zones"},"parentDoc":null,"version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T02:32:14.551Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": \"Z573bd060ae9ac9419f028b63\",\n  \"environmentId\": \"E573bb9ffd717111220812c3a\",\n  \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n  \"alias\": \"zone1\",\n  \"meta\": {\n    \"$label\": \"All of my things\"\n  },\n  \"createdAt\": \"2016-05-18T02:14:34.266Z\"\n}","name":""},{"name":"","status":401,"language":"text","code":""},{"language":"text","code":"","status":403},{"status":404,"language":"text","code":"Zone with id Z573bd060ae9ac9419f028b64 does not exist."}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/zones/Z573bd060ae9ac9419f028b63 HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"droplit console","language":"text","code":"droplit zone get Z573bd060ae9ac9419f028b63"}]},"method":"get","auth":"required","params":[{"_id":"573bd42e2cf9af3200d5890b","ref":"","in":"path","required":true,"desc":"[zone](doc:zones) id or [alias](doc:aliases)","default":"","type":"string","name":"id"},{"_id":"58464a3bc42d272300def6f8","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/zones/:id"},"isReference":true,"order":2,"body":"You can use this endpoint to get basic information about a zone. \n\nThis endpoint does **not** return zone items. You can use [/api/zones/:id/items](https://docs.droplit.io/docs/zones-list-items)","excerpt":"Get zone info","slug":"read-zones","type":"endpoint","title":"Read"}

getRead

Get zone info

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
[zone](doc:zones) id or [alias](doc:aliases)

Headers

x-system-meta-prefix:
string$
[metadata](doc:metadata) prefix

Examples


Result Format


Documentation

You can use this endpoint to get basic information about a zone. This endpoint does **not** return zone items. You can use [/api/zones/:id/items](https://docs.droplit.io/docs/zones-list-items)

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