Skip to content

Zone Read

To return an array of all zones, call the URI http(s)://<qie_server>:<management_api_port>/zone/read with the following payload:

{}

To return an array with a specific zone, call the URI http(s)://<qie_server>:<management_api_port>/zone/read with the following payload:

{
   "zoneName": "<desired zone name>"
}

Base JSON Payload Definition

Node Description
zoneName The name of the zone to delete.

The following response is received if the zone or zones were found:

HTTP Status: 200

[
   {
      "zoneId": "<zone id>",
      "name": "<zone name>",
      "description": "<zone description>",
      "createdTimestamp": <created timestamp>,
      "createdByUserid": "<created by user id>",
      "modifiedTimestamp": <modified timestamp>,
      "modifiedByUserid": "<modified by user id>"
   }
]
Node Description
zoneId The zone id.
name The zone name.
description The zone description.
createdTimestamp The date and time created.
createdByUserid The user id used when created.
modifiedTimestamp The data and time of the last modification
modifiedByUserid The user id used when last modified.

If there is an error returning zones, then the following response is received:

HTTP Status: 400

{
   "error": "<error message>"
}

Example curl command:

curl -H "apiToken:abc123" --request POST http://qieserver:9999/zone/read -d '{"zoneName":"myZoneName"}'

curl -H "apiToken:abc123" --request POST http://qieserver:9999/zone/read -d "{\"zoneName\":\"myZoneName\"}"

curl -H @{"apiToken"="abc123"} -Method POST http://qieserver:9999/zone/read -Body '{"zoneName":"myZoneName"}' | Select-Object -Expand RawContent

Use with caution

This option requires channels to be deleted before deleting the zone.

Deleting a zone deletes everything in that zone. Web Service Connections, etc. Once deleted it can only be restored from a backup configuration or database backup.