Apache CloudStack Zones API

openapi: 3.0.3
info:
  title: Apache CloudStack Networks Zones API
  description: The Apache CloudStack API provides comprehensive REST endpoints for managing virtual machines, networks, storage volumes, accounts, domains, zones, and cloud infrastructure resources. It supports both synchronous and asynchronous operations using a query-parameter-based command dispatch pattern.
  version: 4.19.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    name: Apache CloudStack Community
    url: https://cloudstack.apache.org/
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: http://localhost:8080/client/api
  description: Default local CloudStack Management Server API endpoint
tags:
- name: Zones
  description: Zone and availability zone management operations.
paths:
  /zone/list:
    get:
      operationId: listZones
      summary: Apache CloudStack List Zones
      description: List all availability zones in the CloudStack deployment.
      tags:
      - Zones
      parameters:
      - name: command
        in: query
        required: true
        schema:
          type: string
          enum:
          - listZones
      - name: available
        in: query
        required: false
        schema:
          type: boolean
        description: Filter to only zones available to the calling user.
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of availability zones.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneList'
              examples:
                ListZones200Example:
                  summary: Default listZones 200 response
                  x-microcks-default: true
                  value:
                    listzonesresponse:
                      count: 1
                      zone:
                      - id: zone-uuid-abcd
                        name: us-east-1
                        networktype: Advanced
                        allocationstate: Enabled
                        securitygroupsenabled: false
        '401':
          description: Authentication failed.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - apiKeyAuth: []
components:
  schemas:
    ZoneList:
      title: ZoneList
      description: List of CloudStack availability zones.
      type: object
      properties:
        listzonesresponse:
          type: object
          properties:
            count:
              type: integer
              example: 1
            zone:
              type: array
              items:
                $ref: '#/components/schemas/Zone'
    Zone:
      title: Zone
      description: A CloudStack availability zone grouping compute, network, and storage resources.
      type: object
      properties:
        id:
          type: string
          description: UUID of the zone.
          example: zone-uuid-abcd
        name:
          type: string
          description: Name of the zone.
          example: us-east-1
        networktype:
          type: string
          description: Network type of the zone (Basic or Advanced).
          enum:
          - Basic
          - Advanced
          example: Advanced
        allocationstate:
          type: string
          description: Allocation state of the zone (Enabled or Disabled).
          example: Enabled
        securitygroupsenabled:
          type: boolean
          description: Whether security groups are enabled in the zone.
          example: false
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: query
      name: apikey
      description: CloudStack API key for HMAC-SHA1 signed request authentication.