Get a zone by UUID.

GET 
/v1/zones/:uuid

Get a zone by UUID.

Request

Path Parameters

uuid uuidrequired

Unique identifier for the zone

Responses

200

OK

application/json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

data

object

required

$schema uri

A URL to the JSON Schema for this object.

createdAt date-timerequired

Date and time the zone was created.

customer uuidrequired

Unique identifier for the owner (customer)

deletedAt date-timerequired

Date and time the zone was deleted.

name stringrequired

Possible values: non-empty and <= 80 characters

Name of zone.

updatedAt date-timerequired

Date and time the zone was updated.

uuid uuidrequired

Unique identifier for the zone

zone array[]required

Zone geometry.

status int64required
timestamp date-timerequired

Example (from schema)

{
  "$schema": "string",
  "data": {
    "$schema": "string",
    "createdAt": "2024-06-25T14:10:22.472Z",
    "customer": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "zone": [
      [
        [
          0
        ]
      ]
    ]
  },
  "status": 0,
  "timestamp": "2024-06-25T14:10:22.472Z"
}

default

Error

application/problem+json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

detail string

A human-readable explanation specific to this occurrence of the problem.

errors

object[]

Optional list of individual error details

Array [

location string

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

message string

Error message text

value

The value at the given location

]

instance uri

A URI reference that identifies the specific occurrence of the problem.

status int64

HTTP status code

title string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

type uri

Default value: about:blank

A URI reference to human-readable documentation for the error.

Example (from schema)

{
  "$schema": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Loading...