Apache CloudStack Networks API

openapi: 3.0.3
info:
  title: Apache CloudStack Networks 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: Networks
  description: Network and IP address management operations.
paths:
  /network/list:
    get:
      operationId: listNetworks
      summary: Apache CloudStack List Networks
      description: List all available networks in the cloud with optional filtering by zone or account.
      tags:
      - Networks
      parameters:
      - name: command
        in: query
        required: true
        schema:
          type: string
          enum:
          - listNetworks
      - name: zoneid
        in: query
        required: false
        schema:
          type: string
        description: Filter networks by zone UUID.
      - name: apikey
        in: query
        required: true
        schema:
          type: string
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of networks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkList'
              examples:
                ListNetworks200Example:
                  summary: Default listNetworks 200 response
                  x-microcks-default: true
                  value:
                    listnetworksresponse:
                      count: 1
                      network:
                      - id: net-uuid-1234
                        name: default-network
                        state: Implemented
                        zoneid: zone-uuid-abcd
                        zonename: us-east-1
                        type: Isolated
                        cidr: 10.0.0.0/24
        '401':
          description: Authentication failed.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - apiKeyAuth: []
components:
  schemas:
    NetworkList:
      title: NetworkList
      description: Paginated list of CloudStack networks.
      type: object
      properties:
        listnetworksresponse:
          type: object
          properties:
            count:
              type: integer
              example: 1
            network:
              type: array
              items:
                $ref: '#/components/schemas/Network'
    Network:
      title: Network
      description: A CloudStack network resource providing connectivity for virtual machines.
      type: object
      properties:
        id:
          type: string
          description: UUID of the network.
          example: net-uuid-1234
        name:
          type: string
          description: Display name of the network.
          example: default-network
        state:
          type: string
          description: Current state of the network.
          example: Implemented
        zoneid:
          type: string
          description: UUID of the zone containing the network.
          example: zone-uuid-abcd
        type:
          type: string
          description: Type of network (Isolated, Shared, L2).
          example: Isolated
        cidr:
          type: string
          description: CIDR block of the network.
          example: 10.0.0.0/24
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: query
      name: apikey
      description: CloudStack API key for HMAC-SHA1 signed request authentication.