{
  "opencollection": "1.0.0",
  "info": {
    "name": "Solaris Zones Management API",
    "version": "1.6"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "_rad_session",
      "value": "{{_rad_session}}",
      "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://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/",
            "params": [
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed information including all properties for each interface."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Manager Instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager",
            "params": [
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed information including all properties for each interface."
              }
            ]
          },
          "docs": "Retrieve the ZoneManager singleton interface which provides system-wide zone management operations."
        },
        {
          "info": {
            "name": "Solaris Zones Create a New Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new zone with the specified name, zone path, and brand template. The zone is created in the configured state."
        },
        {
          "info": {
            "name": "Solaris Zones Delete a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete an existing zone. The zone must be in the configured or installed state before it can be deleted."
        },
        {
          "info": {
            "name": "Solaris Zones Create Ephemeral Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/createConfig",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a temporary zone configuration for editing before committing. Used for staged configuration changes."
        },
        {
          "info": {
            "name": "Solaris Zones Import a Zone From Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/importConfig",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Import a zone definition from an exported configuration. Used for restoring or cloning zone configurations."
        },
        {
          "info": {
            "name": "Solaris Zones Initialize Zone Evacuation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/initEvacuate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initialize evacuation of zones from the current host to a remote host. Must be called before evacuate(). Available since API version 1.4."
        },
        {
          "info": {
            "name": "Solaris Zones Evacuate Zones to Remote Host",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/evacuate"
          },
          "docs": "Perform zone evacuation to a previously initialized remote host. Migrates all eligible zones. Available since API version 1.4."
        },
        {
          "info": {
            "name": "Solaris Zones Cancel Zone Evacuation in Progress",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneManager/_rad_method/cancelEvacuate"
          },
          "docs": "Cancel an ongoing zone evacuation operation. Available since API version 1.4."
        }
      ]
    },
    {
      "info": {
        "name": "Zones",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Solaris Zones Get Zone Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              },
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed information including all properties for each interface."
              }
            ]
          },
          "docs": "Retrieve detailed information about a specific zone including its name, brand, state, UUID, and auxiliary states."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Name Property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/name",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Retrieve the name property of a specific zone."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone State",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/state",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Retrieve the current state of a zone. States include configured, incomplete, installed, ready, running, shutting_down, and down."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Brand",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/brand",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Retrieve the brand type of a zone (e.g., solaris, solaris-kz, solaris10)."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Numeric Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/id",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Retrieve the numeric zone ID. Only available when the zone is in running or ready state."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Uuid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/uuid",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Retrieve the universally unique identifier for the zone."
        },
        {
          "info": {
            "name": "Solaris Zones Boot a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/boot",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Boot a zone, transitioning it from installed or ready state to running state. Equivalent to zoneadm boot."
        },
        {
          "info": {
            "name": "Solaris Zones Halt a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/halt",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Immediately halt a running zone. Equivalent to zoneadm halt. Does not run shutdown scripts."
        },
        {
          "info": {
            "name": "Solaris Zones Gracefully Shut Down a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/shutdown",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Gracefully shut down a running zone by running shutdown scripts. Equivalent to zoneadm shutdown."
        },
        {
          "info": {
            "name": "Solaris Zones Reboot a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/reboot",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Reboot a running zone. Equivalent to zoneadm reboot."
        },
        {
          "info": {
            "name": "Solaris Zones Install a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/install",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Install a configured zone, transitioning it from configured to installed state. Equivalent to zoneadm install."
        },
        {
          "info": {
            "name": "Solaris Zones Uninstall a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/uninstall",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Uninstall an installed zone, removing its file system content. Equivalent to zoneadm uninstall."
        },
        {
          "info": {
            "name": "Solaris Zones Clone a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/clone",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clone an existing zone to create a new zone with the same configuration and content. Equivalent to zoneadm clone."
        },
        {
          "info": {
            "name": "Solaris Zones Attach a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/attach",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Attach a previously detached zone. Equivalent to zoneadm attach."
        },
        {
          "info": {
            "name": "Solaris Zones Detach a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/detach",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Detach a zone from the system for migration or archival. Equivalent to zoneadm detach."
        },
        {
          "info": {
            "name": "Solaris Zones Suspend a Zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/suspend",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Suspend a running zone, saving its state for later resumption."
        },
        {
          "info": {
            "name": "Solaris Zones Prepare a Zone for Running",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/ready",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Transition a zone to the ready state without booting it. Equivalent to zoneadm ready."
        },
        {
          "info": {
            "name": "Solaris Zones Verify Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/verify",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Verify the zone configuration for correctness. Equivalent to zoneadm verify."
        },
        {
          "info": {
            "name": "Solaris Zones Migrate a Zone to a Remote Host",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/migrate",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Migrate a zone to a remote host. Supports live and cold migration types. Available since API version 1.1."
        },
        {
          "info": {
            "name": "Solaris Zones Export Zone Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/exportConfig",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Export the zone configuration as a string that can be saved or imported into another system."
        }
      ]
    },
    {
      "info": {
        "name": "Zone Info",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Solaris Zones List Zone Information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/ZoneInfo",
            "params": [
              {
                "name": "_rad_detail",
                "value": "",
                "type": "query",
                "description": "When present, returns detailed information including all properties for each interface."
              }
            ]
          },
          "docs": "Retrieve read-only information about all zones on the system including name, brand, ID, UUID, and whether the zone is a global zone."
        }
      ]
    }
  ],
  "bundled": true
}