Retrieve information for a specific zone (organization).

Retrieve information for a specific zone. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
accountId
required
string <uuid>

Account ID for the specified account

Example: 3d89206d-754f-4308-8c81-b1c886f029cf
zoneId
required
string <uuid>

ID for the specified zone (organization)

Example: ef519091-5a62-476d-add6-d40270f3ebed
Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

get/accounts/{accountId}/zones/{zoneId}
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{
    "Authorization" = "Bearer $apiKey"
    "Content-Type" = "application/json"
}
$url = "https://console.automox.com/api/accounts/{accountId}/zones/{zoneId}"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "summary": "Zone example",
  • "description": "Example of a zone object with complete zone information including creator details and organizational hierarchy",
  • "value": {
    • "id": "00000000-0000-0000-0000-000000000001",
    • "organization_id": 123456,
    • "account_id": "00000000-0000-0000-0000-000000000002",
    • "parent_id": "00000000-0000-0000-0000-000000000003",
    • "name": "Anonymized Zone",
    • "created_by": {
      • "id": "00000000-0000-0000-0000-000000000004",
      • "user_id": 12345,
      • "email": "user@example.com",
      • "first_name": "FirstName",
      • "last_name": "LastName",
      • "status": "active",
      • "account_rbac_role": "global-admin",
      • "is_verified": true,
      • "two_factor_authentication": "email",
      • "created_at": "2023-03-07T17:11:17+0000"
      },
    • "access_key": "00000000-0000-0000-0000-000000000005",
    • "created_at": "2024-04-03T16:19:36+0000",
    • "updated_at": "2024-04-03T16:19:36+0000",
    • "tier": "tier3"
    }
}