Retrieve a zone

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/zones/zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.zones.zones_dto.ZonesDto.SettingsZone;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsZone> response = client.zones().getSettingsZone("zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Zones.GetSettingsZoneAsync("zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Zones().GetSettingsZone(context.Background(), "zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "zone": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>"
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

settings

zones

{zone_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/zones/zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.zones.zones_dto.ZonesDto.SettingsZone;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsZone> response = client.zones().getSettingsZone("zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Zones.GetSettingsZoneAsync("zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Zones().GetSettingsZone(context.Background(), "zn_0a1b2c3d4e5f60718293a4b5c6d7e8f9", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "zone": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "status": "<string>"
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Returns the zone under zone, with its name, display_name, description and status.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

zone_id

string

required

The zone's id, such as zn_ followed by 32 hex digits.

Response

The zone, under zone.

zone

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response