openapi: 3.1.0
info:
  title: Solaris Zones Management API
  description: >-
    Core API for creating, managing, and monitoring Oracle Solaris Zones via the
    Remote Administration Daemon (RAD) REST interface. Provides access to the
    com.oracle.solaris.rad.zonemgr module for zone lifecycle operations including
    creation, deletion, state queries, and evacuation management.
  version: '1.6'
  contact:
    name: Oracle Solaris Support
    url: https://www.oracle.com/solaris/support/
    email: solaris-support@oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
externalDocs:
  description: Oracle Solaris Zones Administration Guide
  url: https://docs.oracle.com/cd/E88353_01/html/E37839/zones.html
servers:
- url: https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6
  description: Oracle Solaris RAD REST endpoint for zone management
  variables:
    host:
      default: localhost
      description: Solaris host running RAD
    port:
      default: '6788'
      description: RAD REST API port (default HTTPS)
tags:
- name: Zone Info
  description: Read-only zone information
- name: Zone Manager
  description: System-wide zone management operations
- name: Zones
  description: Individual zone operations and queries
security:
- cookieAuth: []
paths:
  /:
    get:
      operationId: listZoneInterfaces
      summary: Solaris Zones List All Zone Management Interfaces
      description: >-
        Retrieve a list of all available zone management interfaces including
        ZoneManager, Zone instances, and ZoneInfo. Use the _rad_detail parameter
        to include full property details.
      tags:
      - Zone Manager
      parameters:
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: List of zone management interfaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  payload:
                    type: array
                    items:
                      $ref: '#/components/schemas/RadInterface'
              examples:
                Listzoneinterfaces200Example:
                  summary: Default listZoneInterfaces 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                    - href: example_value
                      type: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager:
    get:
      operationId: getZoneManager
      summary: Solaris Zones Get Zone Manager Instance
      description: >-
        Retrieve the ZoneManager singleton interface which provides system-wide
        zone management operations.
      tags:
      - Zone Manager
      parameters:
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: Zone manager details
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    $ref: '#/components/schemas/ZoneManager'
              examples:
                Getzonemanager200Example:
                  summary: Default getZoneManager 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      evacuationState:
                        status: SUCCESS
                        returning: true
                        migrationResults: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/create:
    put:
      operationId: createZone
      summary: Solaris Zones Create a New Zone
      description: >-
        Create a new zone with the specified name, zone path, and brand template.
        The zone is created in the configured state.
      tags:
      - Zone Manager
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateZoneRequest'
            examples:
              CreatezoneRequestExample:
                summary: Default createZone request
                x-microcks-default: true
                value:
                  name: Example Title
                  path: example_value
                  template: example_value
      responses:
        '200':
          description: Zone created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Createzone200Example:
                  summary: Default createZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/delete:
    put:
      operationId: deleteZone
      summary: Solaris Zones Delete a Zone
      description: >-
        Delete an existing zone. The zone must be in the configured or
        installed state before it can be deleted.
      tags:
      - Zone Manager
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: Name of the zone to delete
            examples:
              DeletezoneRequestExample:
                summary: Default deleteZone request
                x-microcks-default: true
                value:
                  name: Example Title
      responses:
        '200':
          description: Zone deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Deletezone200Example:
                  summary: Default deleteZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/createConfig:
    put:
      operationId: createEphemeralConfig
      summary: Solaris Zones Create Ephemeral Zone Configuration
      description: >-
        Create a temporary zone configuration for editing before committing.
        Used for staged configuration changes.
      tags:
      - Zone Manager
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - template
              properties:
                name:
                  type: string
                  description: Configuration name
                template:
                  type: string
                  description: Zone brand template to base configuration on
            examples:
              CreateephemeralconfigRequestExample:
                summary: Default createEphemeralConfig request
                x-microcks-default: true
                value:
                  name: Example Title
                  template: example_value
      responses:
        '200':
          description: Ephemeral configuration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Createephemeralconfig200Example:
                  summary: Default createEphemeralConfig 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/importConfig:
    put:
      operationId: importZoneConfig
      summary: Solaris Zones Import a Zone From Configuration
      description: >-
        Import a zone definition from an exported configuration. Used for
        restoring or cloning zone configurations.
      tags:
      - Zone Manager
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - config
              properties:
                name:
                  type: string
                  description: Name for the imported zone
                config:
                  type: string
                  description: Zone configuration data to import
            examples:
              ImportzoneconfigRequestExample:
                summary: Default importZoneConfig request
                x-microcks-default: true
                value:
                  name: Example Title
                  config: example_value
      responses:
        '200':
          description: Zone configuration imported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Importzoneconfig200Example:
                  summary: Default importZoneConfig 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/initEvacuate:
    put:
      operationId: initializeEvacuation
      summary: Solaris Zones Initialize Zone Evacuation
      description: >-
        Initialize evacuation of zones from the current host to a remote host.
        Must be called before evacuate(). Available since API version 1.4.
      tags:
      - Zone Manager
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - host
              properties:
                host:
                  type: string
                  description: Remote host to evacuate zones to
                cipher:
                  type: string
                  description: Encryption cipher to use for transfer
            examples:
              InitializeevacuationRequestExample:
                summary: Default initializeEvacuation request
                x-microcks-default: true
                value:
                  host: example_value
                  cipher: example_value
      responses:
        '200':
          description: Evacuation initialized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Initializeevacuation200Example:
                  summary: Default initializeEvacuation 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/evacuate:
    put:
      operationId: evacuateZones
      summary: Solaris Zones Evacuate Zones to Remote Host
      description: >-
        Perform zone evacuation to a previously initialized remote host.
        Migrates all eligible zones. Available since API version 1.4.
      tags:
      - Zone Manager
      responses:
        '200':
          description: Evacuation started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Evacuatezones200Example:
                  summary: Default evacuateZones 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneManager/_rad_method/cancelEvacuate:
    put:
      operationId: cancelEvacuation
      summary: Solaris Zones Cancel Zone Evacuation in Progress
      description: >-
        Cancel an ongoing zone evacuation operation. Available since API version
        1.4.
      tags:
      - Zone Manager
      responses:
        '200':
          description: Evacuation cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadResult'
              examples:
                Cancelevacuation200Example:
                  summary: Default cancelEvacuation 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}:
    get:
      operationId: getZone
      summary: Solaris Zones Get Zone Details
      description: >-
        Retrieve detailed information about a specific zone including its
        name, brand, state, UUID, and auxiliary states.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: Zone details
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    $ref: '#/components/schemas/Zone'
              examples:
                Getzone200Example:
                  summary: Default getZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      name: Example Title
                      brand: example_value
                      id: abc123
                      uuid: '500123'
                      state: configured
                      auxstate:
                      - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/name:
    get:
      operationId: getZoneName
      summary: Solaris Zones Get Zone Name Property
      description: Retrieve the name property of a specific zone.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone name
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: string
              examples:
                Getzonename200Example:
                  summary: Default getZoneName 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload: example_value
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/state:
    get:
      operationId: getZoneState
      summary: Solaris Zones Get Zone State
      description: >-
        Retrieve the current state of a zone. States include configured,
        incomplete, installed, ready, running, shutting_down, and down.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone state
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: string
                    enum:
                    - configured
                    - incomplete
                    - installed
                    - ready
                    - running
                    - shutting_down
                    - down
              examples:
                Getzonestate200Example:
                  summary: Default getZoneState 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload: configured
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/brand:
    get:
      operationId: getZoneBrand
      summary: Solaris Zones Get Zone Brand
      description: >-
        Retrieve the brand type of a zone (e.g., solaris, solaris-kz,
        solaris10).
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone brand
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: string
              examples:
                Getzonebrand200Example:
                  summary: Default getZoneBrand 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload: example_value
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/id:
    get:
      operationId: getZoneId
      summary: Solaris Zones Get Zone Numeric Id
      description: >-
        Retrieve the numeric zone ID. Only available when the zone is in
        running or ready state.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: integer
              examples:
                Getzoneid200Example:
                  summary: Default getZoneId 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload: 10
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/uuid:
    get:
      operationId: getZoneUuid
      summary: Solaris Zones Get Zone Uuid
      description: Retrieve the universally unique identifier for the zone.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone UUID
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: string
                    format: uuid
              examples:
                Getzoneuuid200Example:
                  summary: Default getZoneUuid 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload: example_value
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/boot:
    put:
      operationId: bootZone
      summary: Solaris Zones Boot a Zone
      description: >-
        Boot a zone, transitioning it from installed or ready state to running
        state. Equivalent to zoneadm boot.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                options:
                  type: array
                  items:
                    type: string
                  description: Optional boot arguments
            examples:
              BootzoneRequestExample:
                summary: Default bootZone request
                x-microcks-default: true
                value:
                  options:
                  - example_value
      responses:
        '200':
          description: Zone boot initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Bootzone200Example:
                  summary: Default bootZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/halt:
    put:
      operationId: haltZone
      summary: Solaris Zones Halt a Zone
      description: >-
        Immediately halt a running zone. Equivalent to zoneadm halt.
        Does not run shutdown scripts.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone halted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Haltzone200Example:
                  summary: Default haltZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/shutdown:
    put:
      operationId: shutdownZone
      summary: Solaris Zones Gracefully Shut Down a Zone
      description: >-
        Gracefully shut down a running zone by running shutdown scripts.
        Equivalent to zoneadm shutdown.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone shutdown initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Shutdownzone200Example:
                  summary: Default shutdownZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/reboot:
    put:
      operationId: rebootZone
      summary: Solaris Zones Reboot a Zone
      description: >-
        Reboot a running zone. Equivalent to zoneadm reboot.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone reboot initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Rebootzone200Example:
                  summary: Default rebootZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/install:
    put:
      operationId: installZone
      summary: Solaris Zones Install a Zone
      description: >-
        Install a configured zone, transitioning it from configured to installed
        state. Equivalent to zoneadm install.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                options:
                  type: array
                  items:
                    type: string
                  description: Optional install arguments
            examples:
              InstallzoneRequestExample:
                summary: Default installZone request
                x-microcks-default: true
                value:
                  options:
                  - example_value
      responses:
        '200':
          description: Zone install initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Installzone200Example:
                  summary: Default installZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/uninstall:
    put:
      operationId: uninstallZone
      summary: Solaris Zones Uninstall a Zone
      description: >-
        Uninstall an installed zone, removing its file system content.
        Equivalent to zoneadm uninstall.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone uninstalled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Uninstallzone200Example:
                  summary: Default uninstallZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/clone:
    put:
      operationId: cloneZone
      summary: Solaris Zones Clone a Zone
      description: >-
        Clone an existing zone to create a new zone with the same configuration
        and content. Equivalent to zoneadm clone.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - source
              properties:
                source:
                  type: string
                  description: Name of the source zone to clone from
                snapshot:
                  type: string
                  description: ZFS snapshot to clone from
            examples:
              ClonezoneRequestExample:
                summary: Default cloneZone request
                x-microcks-default: true
                value:
                  source: example_value
                  snapshot: example_value
      responses:
        '200':
          description: Zone cloned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Clonezone200Example:
                  summary: Default cloneZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/attach:
    put:
      operationId: attachZone
      summary: Solaris Zones Attach a Zone
      description: >-
        Attach a previously detached zone. Equivalent to zoneadm attach.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                options:
                  type: array
                  items:
                    type: string
                  description: Optional attach arguments
            examples:
              AttachzoneRequestExample:
                summary: Default attachZone request
                x-microcks-default: true
                value:
                  options:
                  - example_value
      responses:
        '200':
          description: Zone attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Attachzone200Example:
                  summary: Default attachZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/detach:
    put:
      operationId: detachZone
      summary: Solaris Zones Detach a Zone
      description: >-
        Detach a zone from the system for migration or archival.
        Equivalent to zoneadm detach.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone detached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Detachzone200Example:
                  summary: Default detachZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/suspend:
    put:
      operationId: suspendZone
      summary: Solaris Zones Suspend a Zone
      description: >-
        Suspend a running zone, saving its state for later resumption.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone suspended
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Suspendzone200Example:
                  summary: Default suspendZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/ready:
    put:
      operationId: readyZone
      summary: Solaris Zones Prepare a Zone for Running
      description: >-
        Transition a zone to the ready state without booting it.
        Equivalent to zoneadm ready.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Readyzone200Example:
                  summary: Default readyZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/verify:
    put:
      operationId: verifyZone
      summary: Solaris Zones Verify Zone Configuration
      description: >-
        Verify the zone configuration for correctness. Equivalent to
        zoneadm verify.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone verification result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Verifyzone200Example:
                  summary: Default verifyZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/migrate:
    put:
      operationId: migrateZone
      summary: Solaris Zones Migrate a Zone to a Remote Host
      description: >-
        Migrate a zone to a remote host. Supports live and cold migration
        types. Available since API version 1.1.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MigrateZoneRequest'
            examples:
              MigratezoneRequestExample:
                summary: Default migrateZone request
                x-microcks-default: true
                value:
                  host: example_value
                  type: live
                  cipher: example_value
      responses:
        '200':
          description: Migration initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneResult'
              examples:
                Migratezone200Example:
                  summary: Default migrateZone 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                      code: NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/_rad_method/exportConfig:
    put:
      operationId: exportZoneConfig
      summary: Solaris Zones Export Zone Configuration
      description: >-
        Export the zone configuration as a string that can be saved or imported
        into another system.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone configuration exported
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: string
                    description: Exported zone configuration
              examples:
                Exportzoneconfig200Example:
                  summary: Default exportZoneConfig 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ZoneInfo:
    get:
      operationId: listZoneInfo
      summary: Solaris Zones List Zone Information
      description: >-
        Retrieve read-only information about all zones on the system including
        name, brand, ID, UUID, and whether the zone is a global zone.
      tags:
      - Zone Info
      parameters:
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: Zone information list
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      $ref: '#/components/schemas/ZoneInfo'
              examples:
                Listzoneinfo200Example:
                  summary: Default listZoneInfo 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                    - name: Example Title
                      brand: example_value
                      id: abc123
                      uuid: '500123'
                      isGlobal: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: _rad_session
      description: >-
        RAD session cookie obtained via authentication. Establish a session
        by posting credentials to the RAD authentication endpoint.
  parameters:
    zoneName:
      name: zoneName
      in: path
      required: true
      description: Name of the zone
      schema:
        type: string
    radDetail:
      name: _rad_detail
      in: query
      required: false
      description: >-
        When present, returns detailed information including all properties
        for each interface.
      schema:
        type: boolean
  responses:
    Unauthorized:
      description: Authentication required or session expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RadError'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RadError'
    NotFound:
      description: Zone or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RadError'
  schemas:
    RadInterface:
      type: object
      properties:
        href:
          type: string
          description: URL path to the interface
          example: example_value
        type:
          type: string
          description: Interface type name
          example: example_value
    RadResult:
      type: object
      properties:
        status:
          type: string
          enum:
          - success
          - failure
          example: success
        payload:
          type: object
          description: Result payload
          example: example_value
    RadError:
      type: object
      properties:
        status:
          type: string
          example: failure
        payload:
          type: object
          properties:
            code:
              type: integer
              description: Error code
            message:
              type: string
              description: Error message
          example: example_value
    ZoneManager:
      type: object
      properties:
        evacuationState:
          $ref: '#/components/schemas/EvacuationResult'
          description: Current evacuation state if any
    Zone:
      type: object
      properties:
        name:
          type: string
          description: Zone name
          example: Example Title
        brand:
          type: string
          description: Zone brand type (e.g., solaris, solaris-kz, solaris10)
          example: example_value
        id:
          type: integer
          description: Numeric zone ID (only when running or ready)
          example: abc123
        uuid:
          type: string
          format: uuid
          description: Zone UUID
          example: '500123'
        state:
          type: string
          enum:
          - configured
          - incomplete
          - installed
          - ready
          - running
          - shutting_down
          - down
          description: Current zone state
          example: configured
        auxstate:
          type: array
          items:
            type: string
          description: Auxiliary zone states
          example: []
    ZoneInfo:
      type: object
      properties:
        name:
          type: string
          description: Zone name
          example: Example Title
        brand:
          type: string
          description: Zone brand type
          example: example_value
        id:
          type: integer
          description: Numeric zone ID
          example: abc123
        uuid:
          type: string
          format: uuid
          description: Zone UUID
          example: '500123'
        isGlobal:
          type: boolean
          description: Whether this is a global zone
          example: true
    ZoneResult:
      type: object
      properties:
        status:
          type: string
          example: example_value
        payload:
          type: object
          properties:
            code:
              type: string
              enum:
              - NONE
              - FRAMEWORK_ERROR
              - SNAPSHOT_ERROR
              - COMMAND_ERROR
              - RESOURCE_ALREADY_EXISTS
              - RESOURCE_NOT_FOUND
              - RESOURCE_TOO_MANY
              - RESOURCE_UNKNOWN
              - ALREADY_EDITING
              - INCOMPLETE_NO_CONFIG
              - PROPERTY_UNKNOWN
              - NOT_EDITING
              - SYSTEM_ERROR
              - INVALID_ARGUMENT
              - INVALID_ZONE_STATE
              description: Error code
            message:
              type: string
              description: Error or success message
            stdout:
              type: string
              description: Standard output from the operation
            stderr:
              type: string
              description: Standard error from the operation
          example: example_value
    CreateZoneRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name of the new zone
          example: Example Title
        path:
          type: string
          description: Zone root path
          example: example_value
        template:
          type: string
          description: Zone brand template (e.g., SYSdefault)
          default: SYSdefault
          example: example_value
    MigrateZoneRequest:
      type: object
      required:
      - host
      - type
      properties:
        host:
          type: string
          description: Remote host to migrate the zone to
          example: example_value
        type:
          type: string
          enum:
          - live
          - cold
          description: Migration type
          example: live
        cipher:
          type: string
          description: Encryption cipher for the migration transfer
          example: example_value
    EvacuationResult:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAIL
          - PARTIAL_FAIL
          description: Overall evacuation status
          example: SUCCESS
        returning:
          type: boolean
          description: Whether this is a return evacuation
          example: true
        migrationResults:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EvacuationMigrationResult'
          description: Per-zone migration results keyed by zone name
          example: example_value
    EvacuationMigrationResult:
      type: object
      properties:
        zoneName:
          type: string
          description: Name of the zone
          example: example_value
        evacuated:
          type: boolean
          description: Whether the zone was successfully evacuated
          example: true
        evacuationTarget:
          type: string
          description: Destination host
          example: example_value
        migrationStatus:
          type: string
          description: Migration status
          example: example_value
        migrationError:
          $ref: '#/components/schemas/MigrationError'
    MigrationError:
      type: object
      properties:
        operation:
          type: string
          enum:
          - FRAMEWORK
          - CONNECT
          - INIT_CRYPTO
          - CONFIG_CHECK
          - CONFIGURE
          - ATTACH
          - BOOT
          - MIGRATE_INITIAL
          - MIGRATE
          - SUSPEND
          - RESTART
          - HALT
          - DETACH
          - UNCONFIGURE
          - COMPLETE
          - CANCEL
          description: The operation that failed
          example: FRAMEWORK
        error:
          type: string
          description: System or zone configuration error
          example: example_value
        message:
          type: string
          description: Human-readable error message
          example: example_value