Solaris Zones Zones API

openapi: 3.1.0
info:
  title: Solaris Oracle Solaris Kernel Archive Creation Zones API
  description: REST API for creating and managing Oracle Solaris Kernel Zones via the RAD zonemgr module. Kernel Zones (brand solaris-kz) are non-global zones with their own kernel, providing greater independence and enhanced security isolation compared to native zones. They support live migration, independent patching, and hardware-assisted virtualization.
  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
servers:
- url: https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6
  description: Oracle Solaris RAD REST endpoint
  variables:
    host:
      default: localhost
      description: Solaris host running RAD
    port:
      default: '6788'
      description: RAD REST API port
security:
- cookieAuth: []
tags:
- name: Zones
  description: Individual zone operations including configuration, lifecycle, and resource management
paths:
  /Zone/{zoneName}:
    get:
      operationId: getZone
      summary: Solaris Zones Get Zone Details
      description: Returns detailed information about a specific zone including its current state, brand, UUID, auxiliary states, and configuration.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: Zone details returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  payload:
                    $ref: '#/components/schemas/ZoneDetail'
              examples:
                Getzone200Example:
                  summary: Default getZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      name: Example Title
                      id: abc123
                      uuid: '500123'
                      state: configured
                      brand: solaris
                      auxstate:
                      - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/boot:
    put:
      operationId: bootZone
      summary: Solaris Zones Boot a Zone
      description: Boot the specified zone. The zone must be in the installed state. After booting, the zone transitions to the running state.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  properties:
                    options:
                      type: array
                      items:
                        type: string
                      description: Optional boot arguments
            examples:
              BootzoneRequestExample:
                summary: Default bootZone request
                x-microcks-default: true
                value:
                  payload:
                    options:
                    - example_value
      responses:
        '200':
          description: Zone boot initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Bootzone200Example:
                  summary: Default bootZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/shutdown:
    put:
      operationId: shutdownZone
      summary: Solaris Zones Shutdown a Zone
      description: Gracefully shut down the specified zone by running the shutdown scripts within the zone before halting it.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  properties:
                    options:
                      type: array
                      items:
                        type: string
                      description: Optional shutdown arguments
            examples:
              ShutdownzoneRequestExample:
                summary: Default shutdownZone request
                x-microcks-default: true
                value:
                  payload:
                    options:
                    - example_value
      responses:
        '200':
          description: Zone shutdown initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Shutdownzone200Example:
                  summary: Default shutdownZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/halt:
    put:
      operationId: haltZone
      summary: Solaris Zones Halt a Zone
      description: Immediately halt the specified zone without running shutdown scripts. The zone transitions from running to installed state.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              HaltzoneRequestExample:
                summary: Default haltZone request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone halted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Haltzone200Example:
                  summary: Default haltZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/reboot:
    put:
      operationId: rebootZone
      summary: Solaris Zones Reboot a Zone
      description: Reboot the specified zone. This is equivalent to a halt followed by a boot operation.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  properties:
                    options:
                      type: array
                      items:
                        type: string
                      description: Optional reboot arguments
            examples:
              RebootzoneRequestExample:
                summary: Default rebootZone request
                x-microcks-default: true
                value:
                  payload:
                    options:
                    - example_value
      responses:
        '200':
          description: Zone reboot initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Rebootzone200Example:
                  summary: Default rebootZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/install:
    put:
      operationId: installZone
      summary: Solaris Zones Install a Zone
      description: Install the specified zone. The zone must be in the configured state. After installation, the zone transitions to the installed state and can be booted.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  properties:
                    options:
                      type: array
                      items:
                        type: string
                      description: Optional install arguments
            examples:
              InstallzoneRequestExample:
                summary: Default installZone request
                x-microcks-default: true
                value:
                  payload:
                    options:
                    - example_value
      responses:
        '200':
          description: Zone install initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Installzone200Example:
                  summary: Default installZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/uninstall:
    put:
      operationId: uninstallZone
      summary: Solaris Zones Uninstall a Zone
      description: Uninstall the specified zone, removing all zone data from disk. The zone transitions from installed back to configured state.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              UninstallzoneRequestExample:
                summary: Default uninstallZone request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone uninstalled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Uninstallzone200Example:
                  summary: Default uninstallZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/clone:
    put:
      operationId: cloneZone
      summary: Solaris Zones Clone a Zone
      description: Clone the specified zone from an existing zone or snapshot, providing a fast method to create zone instances with identical configurations.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - payload
              properties:
                payload:
                  type: object
                  required:
                  - sourceZone
                  properties:
                    sourceZone:
                      type: string
                      description: Name of the source zone to clone from
                    snapshot:
                      type: string
                      description: Optional ZFS snapshot to clone from
            examples:
              ClonezoneRequestExample:
                summary: Default cloneZone request
                x-microcks-default: true
                value:
                  payload:
                    sourceZone: example_value
                    snapshot: example_value
      responses:
        '200':
          description: Zone cloned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Clonezone200Example:
                  summary: Default cloneZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/attach:
    put:
      operationId: attachZone
      summary: Solaris Zones Attach a Zone
      description: Attach a previously detached zone, making it available for use on this system. Validates the zone configuration against the current system.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
                  properties:
                    options:
                      type: array
                      items:
                        type: string
                      description: Optional attach arguments
            examples:
              AttachzoneRequestExample:
                summary: Default attachZone request
                x-microcks-default: true
                value:
                  payload:
                    options:
                    - example_value
      responses:
        '200':
          description: Zone attached successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Attachzone200Example:
                  summary: Default attachZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/detach:
    put:
      operationId: detachZone
      summary: Solaris Zones Detach a Zone
      description: Detach the specified zone from this system, preparing it for migration or relocation to another system.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              DetachzoneRequestExample:
                summary: Default detachZone request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone detached successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Detachzone200Example:
                  summary: Default detachZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/suspend:
    put:
      operationId: suspendZone
      summary: Solaris Zones Suspend a Zone
      description: Suspend the specified running zone, saving its state to disk. The zone can later be resumed to continue execution from the point of suspension.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              SuspendzoneRequestExample:
                summary: Default suspendZone request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone suspended successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Suspendzone200Example:
                  summary: Default suspendZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/ready:
    put:
      operationId: readyZone
      summary: Solaris Zones Ready a Zone
      description: Transition the zone to the ready state, which sets up the virtual platform for the zone but does not start any processes within it.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              ReadyzoneRequestExample:
                summary: Default readyZone request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone readied successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Readyzone200Example:
                  summary: Default readyZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/verify:
    put:
      operationId: verifyZone
      summary: Solaris Zones Verify Zone Configuration
      description: Verify that the zone configuration is valid and that all required resources are available on the system.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              VerifyzoneRequestExample:
                summary: Default verifyZone request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone verification result returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Verifyzone200Example:
                  summary: Default verifyZone 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/editConfig:
    put:
      operationId: editZoneConfig
      summary: Solaris Zones Begin Editing Zone Configuration
      description: Initiate a configuration editing session for the specified zone. Takes a snapshot of the current configuration that can be modified and then committed or cancelled.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              EditzoneconfigRequestExample:
                summary: Default editZoneConfig request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Configuration editing session started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Editzoneconfig200Example:
                  summary: Default editZoneConfig 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/commitConfig:
    put:
      operationId: commitZoneConfig
      summary: Solaris Zones Commit Zone Configuration Changes
      description: Save all pending configuration changes made during the current editing session. The changes are written to persistent storage.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              CommitzoneconfigRequestExample:
                summary: Default commitZoneConfig request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Configuration committed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Commitzoneconfig200Example:
                  summary: Default commitZoneConfig 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/cancelConfig:
    put:
      operationId: cancelZoneConfig
      summary: Solaris Zones Cancel Zone Configuration Changes
      description: Discard all pending configuration changes and end the current editing session without saving.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              CancelzoneconfigRequestExample:
                summary: Default cancelZoneConfig request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Configuration editing cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Cancelzoneconfig200Example:
                  summary: Default cancelZoneConfig 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload:
                      code: ZEC_NONE
                      message: example_value
                      stdout: example_value
                      stderr: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/exportConfig:
    put:
      operationId: exportZoneConfig
      summary: Solaris Zones Export Zone Configuration
      description: Export the zone configuration in zonecfg(8) format text that can be used to recreate the zone on another system using importConfig.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              ExportzoneconfigRequestExample:
                summary: Default exportZoneConfig request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Zone configuration exported
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  payload:
                    type: string
                    description: Zone configuration in zonecfg export format
              examples:
                Exportzoneconfig200Example:
                  summary: Default exportZoneConfig 200 response
                  x-microcks-default: true
                  value:
                    status: success
                    payload: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Zone not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Zone/{zoneName}/apply:
    put:
      operationId: applyZoneConfig
      summary: Solaris Zones Apply Configuration to Running Zone
      description: Apply committed configuration changes to a running zone without requiring a reboot. Not all configuration changes support live application.
      tags:
      - Zones
      parameters:
      - $ref: '#/components/parameters/zoneName'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  type: object
            examples:
              ApplyzoneconfigRequestExample:
                summary: Default applyZoneConfig request
                x-microcks-default: true
                value:
                  payload: example_value
      responses:
        '200':
          description: Configuration applied to running zone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultResponse'
              examples:
                Applyzoneconfig200Example:
                  summary: Default applyZoneConfig 200 response
                  x-microcks-default: true
     

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solaris-zones/refs/heads/main/openapi/solaris-zones-zones-api-openapi.yml