Get a zone.

Details

Get 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.

Responses

200

{
    "alias": "ZONE-ALIAS",
    "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED",
    "ecosystemId": "ECOSYSTEM-ID",
    "environmentId": "ENVIRONMENT-ID",
    "id": "ZONE-ID",
    "meta": {}
}

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.

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

GET https://ioe.droplit.io/api/zones/ZONE-ID HTTP/1.1
authorization: TOKEN

Droplit Console

droplit zone info ZONE-ID

Droplit SDK

droplit.zones.info("ZONE-ID");
Language
Authorization
Header
Click Try It! to start a request and see the response here!