{"_id":"59c7ee6c23d78a002ebad337","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:42:04.009Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a85c5502c545000f08a7a5","results":{"codes":[]},"examples":{"codes":[]},"method":"put","auth":"required","params":[{"_id":"59c7ed16c50cf30010d712e2","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59c7ee6c23d78a002ebad33a","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"meta"},{"_id":"59c7ee6c23d78a002ebad339","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"alias"},{"_id":"59c7ee6c23d78a002ebad338","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_string","name":"items"}],"url":"/:id"},"isReference":false,"order":3,"body":"# Details\n\nUpdate a zone.\n\nAn account token, server token, or user token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- id (required): The ID of a zone.\n\n## body\n\n- meta (optional): The metadata associated with the zone.\n- alias (optional): The alias associated with the zone.\n- items (optional): The array of zone and device IDs that are contained inside the given zone.\n\n## header\n\n- x-system-metadata-prefix (optional): A customized metadata prefix. The default is “$.”\n\n# Responses\n\n## 200\n\n- No content returned, only the status code. See the REST API “Standard Responses” page.\n\n## 400\n\n- __Zone Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the ID given for a zone was not valid.\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n- __Metadata Format Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that metadata, when specified, should have been formatted as a valid JSON object, and it was not formatted that way.\n- __Alias Invalid:__ The standard error structure defines this error as invalid parameters. The error means that an alias given for an object is not valid. However, this invalid alias does not necessarily mean that any other object references are invalid. This error refers only to the alias itself.\n- __Alias Exists:__ The standard error structure defines this error as an invalid body. The error means that an object with the same alias already exists. The best way to avoid this error is to make sure all aliases are unique strings, regardless of where they are accessed from.\n\n## 404\n\n- __Zone Not Found:__ This error means that a zone with the given ID was not found, although it existed at some point.\n\n# Examples\n\n## HTTP\n\n```\nPUT https://ioe.droplit.io/api/zones/ZONE-ID HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/json\n{\n    \"meta\": {}\n}\n```\n\n## Droplit Console\n\n```\ndroplit zone update ZONE-ID PROPERTY-NAME PROPERTY-VALUE\n```","excerpt":"","slug":"zones-update","type":"endpoint","title":"Update a zone."}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

Body Params

meta:
string
alias:
string
items:
array of strings

Documentation

# Details Update a zone. An account token, server token, or user token may be used to run this endpoint. # Parameters ## path - id (required): The ID of a zone. ## body - meta (optional): The metadata associated with the zone. - alias (optional): The alias associated with the zone. - items (optional): The array of zone and device IDs that are contained inside the given zone. ## header - x-system-metadata-prefix (optional): A customized metadata prefix. The default is “$.” # Responses ## 200 - No content returned, only the status code. See the REST API “Standard Responses” page. ## 400 - __Zone Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the ID given for a zone was not valid. - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. - __Metadata Format Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that metadata, when specified, should have been formatted as a valid JSON object, and it was not formatted that way. - __Alias Invalid:__ The standard error structure defines this error as invalid parameters. The error means that an alias given for an object is not valid. However, this invalid alias does not necessarily mean that any other object references are invalid. This error refers only to the alias itself. - __Alias Exists:__ The standard error structure defines this error as an invalid body. The error means that an object with the same alias already exists. The best way to avoid this error is to make sure all aliases are unique strings, regardless of where they are accessed from. ## 404 - __Zone Not Found:__ This error means that a zone with the given ID was not found, although it existed at some point. # Examples ## HTTP ``` PUT https://ioe.droplit.io/api/zones/ZONE-ID HTTP/1.1 authorization: TOKEN content-type: application/json { "meta": {} } ``` ## Droplit Console ``` droplit zone update ZONE-ID PROPERTY-NAME PROPERTY-VALUE ```

User Information

Try It Out

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