{
  "opencollection": "1.0.0",
  "info": {
    "name": "Solaris Zones Oracle Solaris RAD Zone Management REST API",
    "version": "1.6"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "_rad_cookie",
      "value": "{{_rad_cookie}}",
      "placement": "query"
    }
  },
  "items": [
    {
      "info": {
        "name": "Zone Manager",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Solaris Zones List All Zone Management Interfaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/",
            "params": [
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed property information for each interface or object in the response."
              }
            ]
          },
          "docs": "Returns a list of all available zone management interfaces including ZoneManager, Zone instances, ZoneInfo, and migration connections. Use the _rad_detail query parameter to get full property details."
        },
        {
          "info": {
            "name": "Solaris Zones Get the Zonemanager Singleton",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager",
            "params": [
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed property information for each interface or object in the response."
              }
            ]
          },
          "docs": "Returns the ZoneManager interface which provides system-wide zone management capabilities including zone creation, deletion, and evacuation state information."
        },
        {
          "info": {
            "name": "Solaris Zones Create a New Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Solaris zone with the specified name, zone path, and optional template. The zone is created in the configured state and must be installed and booted separately."
        },
        {
          "info": {
            "name": "Solaris Zones Delete a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Permanently deletes a zone from the system. The zone must be in the configured state before it can be deleted."
        },
        {
          "info": {
            "name": "Solaris Zones Import Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/importConfig",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Import a zone configuration from zonecfg(8) format text, creating a new zone with the specified configuration."
        }
      ]
    },
    {
      "info": {
        "name": "Zone Migration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Solaris Zones Initialize Zone Evacuation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/initEvacuate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initialize an evacuation session to migrate all eligible zones from this host to a remote system. Added in version 1.4 of the zonemgr module."
        },
        {
          "info": {
            "name": "Solaris Zones Perform Zone Evacuation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/evacuate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Execute the evacuation of all eligible zones to the previously configured remote host. Must be preceded by initEvacuate."
        },
        {
          "info": {
            "name": "Solaris Zones Cancel Zone Evacuation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/cancelEvacuate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel an in-progress evacuation operation. Zones that have already been migrated will remain on the remote host."
        },
        {
          "info": {
            "name": "Solaris Zones Migrate a Zone to a Remote Host",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/migrate",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Migrate the specified zone to a remote Solaris host. Supports both live migration (zone continues running during transfer) and cold migration (zone is halted first). Added in version 1.1."
        }
      ]
    },
    {
      "info": {
        "name": "Zones",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Solaris Zones Get Zone Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              },
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed property information for each interface or object in the response."
              }
            ]
          },
          "docs": "Returns detailed information about a specific zone including its current state, brand, UUID, auxiliary states, and configuration."
        },
        {
          "info": {
            "name": "Solaris Zones Boot a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/boot",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Boot the specified zone. The zone must be in the installed state. After booting, the zone transitions to the running state."
        },
        {
          "info": {
            "name": "Solaris Zones Shutdown a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/shutdown",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Gracefully shut down the specified zone by running the shutdown scripts within the zone before halting it."
        },
        {
          "info": {
            "name": "Solaris Zones Halt a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/halt",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Immediately halt the specified zone without running shutdown scripts. The zone transitions from running to installed state."
        },
        {
          "info": {
            "name": "Solaris Zones Reboot a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/reboot",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reboot the specified zone. This is equivalent to a halt followed by a boot operation."
        },
        {
          "info": {
            "name": "Solaris Zones Install a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/install",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Solaris Zones Uninstall a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/uninstall",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Uninstall the specified zone, removing all zone data from disk. The zone transitions from installed back to configured state."
        },
        {
          "info": {
            "name": "Solaris Zones Clone a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/clone",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clone the specified zone from an existing zone or snapshot, providing a fast method to create zone instances with identical configurations."
        },
        {
          "info": {
            "name": "Solaris Zones Attach a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/attach",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Attach a previously detached zone, making it available for use on this system. Validates the zone configuration against the current system."
        },
        {
          "info": {
            "name": "Solaris Zones Detach a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/detach",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Detach the specified zone from this system, preparing it for migration or relocation to another system."
        },
        {
          "info": {
            "name": "Solaris Zones Suspend a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/suspend",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Suspend the specified running zone, saving its state to disk. The zone can later be resumed to continue execution from the point of suspension."
        },
        {
          "info": {
            "name": "Solaris Zones Ready a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/ready",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transition the zone to the ready state, which sets up the virtual platform for the zone but does not start any processes within it."
        },
        {
          "info": {
            "name": "Solaris Zones Verify Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/verify",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verify that the zone configuration is valid and that all required resources are available on the system."
        },
        {
          "info": {
            "name": "Solaris Zones Begin Editing Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/editConfig",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Solaris Zones Commit Zone Configuration Changes",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/commitConfig",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Save all pending configuration changes made during the current editing session. The changes are written to persistent storage."
        },
        {
          "info": {
            "name": "Solaris Zones Cancel Zone Configuration Changes",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/cancelConfig",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Discard all pending configuration changes and end the current editing session without saving."
        },
        {
          "info": {
            "name": "Solaris Zones Export Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/exportConfig",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Export the zone configuration in zonecfg(8) format text that can be used to recreate the zone on another system using importConfig."
        },
        {
          "info": {
            "name": "Solaris Zones Apply Configuration to Running Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/apply",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Apply committed configuration changes to a running zone without requiring a reboot. Not all configuration changes support live application."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Resources",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/getResources",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve resources configured for the zone that match the specified filter criteria. Resources include anet, capped-cpu, capped-memory, fs, device, and other zone resource types."
        },
        {
          "info": {
            "name": "Solaris Zones Add a Resource to Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/addResource",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a new resource to the zone configuration. The zone must be in an editing session started with editConfig. Changes are not persisted until commitConfig is called."
        },
        {
          "info": {
            "name": "Solaris Zones Remove Resources From Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/removeResources",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove resources matching the specified filter from the zone configuration. Requires an active editing session."
        },
        {
          "info": {
            "name": "Solaris Zones Set Resource Properties",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/setResourceProperties",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify properties of zone resources matching the specified filter. Requires an active editing session."
        },
        {
          "info": {
            "name": "Solaris Zones Rename a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/rename",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Rename the specified zone. The zone must not be running when this operation is performed."
        },
        {
          "info": {
            "name": "Solaris Zones Move Zone to New Path",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/move",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the Solaris zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Move the zone root to a new file system path on the same host. The zone must not be running."
        }
      ]
    },
    {
      "info": {
        "name": "Zone Info",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Solaris Zones Get Executing Zone Information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{radserver}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneInfo",
            "params": [
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed property information for each interface or object in the response."
              }
            ]
          },
          "docs": "Returns read-only information about the zone in which the RAD daemon is currently executing, including whether it is the global zone."
        }
      ]
    }
  ],
  "bundled": true
}