REST Resource: zones

Resource: Zone

Represents a Zone resource.

A zone is a deployment area. These deployment areas are subsets of a region. For example the zone

us-east1-b

is located in the

us-east1

region. For more information, read Regions and Zones.

JSON representation
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": enum (ZoneStatus),
  "deprecated": {
    object (DeprecationStatus)
  },
  "region": string,
  "selfLink": string,
  "availableCpuPlatforms": [
    string
  ],
  "supportsPzs": boolean,
  "resourceStatus": {
    object (ResourceStatus)
  }
}
Fields
kind

string

Output only. Type of the resource. Always

compute#zone

for zones.

id

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

Output only. Creation timestamp in RFC3339 text format.

name

string

Output only. Name of the resource.

description

string

Output only. Textual description of the resource.

status

enum (ZoneStatus)

Output only. Status of the zone, either

UP

or

DOWN

.

deprecated

object (DeprecationStatus)

Output only. The deprecation status associated with this zone.

region

string

Output only. Full URL reference to the region which hosts the zone.

availableCpuPlatforms[]

string

Output only. Available cpu/platform selections for the zone.

supportsPzs

boolean

Output only. Reserved for future use.

Available from 2026-03-01..

resourceStatus

object (ResourceStatus)

ZoneStatus

Enums
UP
DOWN

ResourceStatus

JSON representation
{
  "upcomingMaintenances": [
    {
      object (PeriodicPartialMaintenanceSchedule)
    }
  ]
}
Fields
upcomingMaintenances[]

object (PeriodicPartialMaintenanceSchedule)

Output only. The upcoming maintenance schedule.

PeriodicPartialMaintenanceSchedule

The periodic partial maintenance schedule includes 52 weeks worth of maintenance windows. LINT.IfChange(PeriodicPartialMaintenanceSchedule)

JSON representation
{
  "type": enum (Type),
  "subType": enum (SubType),
  "targetResource": string,
  "windowStartTime": {
    object (DateTime)
  },
  "windowEndTime": {
    object (DateTime)
  }
}
Fields
type

enum (Type)

subType

enum (SubType)

The maintenance type in which the zone is during the given window.

targetResource

string

The target resource that the maintenance window is for. For example, "projects/my-project/zones/us-central1-a".

windowStartTime

object (DateTime)

The start civil timestamp of the window. This contains a time zone.

windowEndTime

object (DateTime)

The end civil timestamp of the window (not inclusive). This contains a time zone.

Type

The type of maintenance window.

Enums
MAINTENANCE_TYPE_UNSPECIFIED Default value.
PRIVATE_ZONE_MAINTENANCE The zone is in a private maintenance window.

SubType

State of the maintenance window.

Enums
MAINTENANCE_SUBTYPE_UNSPECIFIED Default value.
MAINTENANCE_TYPE_TRANSITION For preliminary, non-disruptive tasks such as key rotations.
MAINTENANCE_TYPE_DISRUPTIVE_UPGRADE For disruptive updates, including host machine kernel or firmware upgrades.
MAINTENANCE_TYPE_CUSTOMER_MAINTENANCE A dedicated window for customers to perform their own maintenance. This often runs concurrently with a DISRUPTIVE_UPGRADE.
MAINTENANCE_TYPE_STABLE A post-maintenance window for customers to conduct final testing and performance validation before resuming full business operations.

Methods

get

Returns the specified Zone resource.

list

Retrieves the list of Zone resources available to the specified project.