Solaris Zones Zone State API

openapi: 3.1.0
info:
  title: Solaris Zones Oracle Solaris Kernel Zones Archive Creation Zone State 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: Zone State
  description: Zone state monitoring via zonemgr module
paths:
  /com.oracle.solaris.rad.zonemgr/1.6/Zone/{zoneName}/state:
    get:
      operationId: getZoneState
      summary: Solaris Zones Get Zone Current State
      description: Retrieve the current lifecycle state of a zone (configured, installed, ready, running, shutting_down, down).
      tags:
      - Zone State
      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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /com.oracle.solaris.rad.zonemgr/1.6/Zone/{zoneName}/id:
    get:
      operationId: getZoneId
      summary: Solaris Zones Get Zone Numeric Id
      description: Retrieve the numeric ID assigned to a zone. Only available when the zone is in running or ready state.
      tags:
      - Zone State
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone numeric 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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /com.oracle.solaris.rad.zonemgr/1.6/Zone/{zoneName}/auxstate:
    get:
      operationId: getZoneAuxState
      summary: Solaris Zones Get Zone Auxiliary States
      description: Retrieve auxiliary state flags for a zone. These provide additional status information beyond the primary lifecycle state.
      tags:
      - Zone State
      parameters:
      - $ref: '#/components/parameters/zoneName'
      responses:
        '200':
          description: Zone auxiliary states
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      type: string
              examples:
                Getzoneauxstate200Example:
                  summary: Default getZoneAuxState 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
  /com.oracle.solaris.rad.zonemgr/1.6:
    get:
      operationId: listAllZones
      summary: Solaris Zones List All Zones With Status
      description: Retrieve a list of all zones on the system with their current state and properties. Use _rad_detail for full zone information.
      tags:
      - Zone State
      parameters:
      - $ref: '#/components/parameters/radDetail'
      responses:
        '200':
          description: List of all zone interfaces
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      $ref: '#/components/schemas/ZoneInterface'
              examples:
                Listallzones200Example:
                  summary: Default listAllZones 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    payload:
                    - href: example_value
                      type: example_value
                      name: Example Title
                      state: example_value
                      brand: example_value
                      id: abc123
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    RadError:
      type: object
      properties:
        status:
          type: string
          example: failure
        payload:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
          example: example_value
    ZoneInterface:
      type: object
      properties:
        href:
          type: string
          description: URL path to the zone interface
          example: example_value
        type:
          type: string
          description: Interface type (Zone, ZoneInfo, ZoneManager)
          example: example_value
        name:
          type: string
          description: Zone name
          example: Example Title
        state:
          type: string
          description: Current zone state
          example: example_value
        brand:
          type: string
          description: Zone brand
          example: example_value
        id:
          type: integer
          description: Zone numeric ID
          example: abc123
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RadError'
    Unauthorized:
      description: Authentication required or session expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RadError'
  parameters:
    radDetail:
      name: _rad_detail
      in: query
      required: false
      description: Returns detailed property information when present
      schema:
        type: boolean
    zoneName:
      name: zoneName
      in: path
      required: true
      description: Name of the zone
      schema:
        type: string
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: _rad_session
      description: RAD session cookie obtained via authentication
externalDocs:
  description: Oracle Solaris Kernel Zones Documentation
  url: https://docs.oracle.com/en/operating-systems/solaris/oracle-solaris/11.4/kernel-zones/oracle-solaris-kernel-zones.html