{
  "opencollection": "1.0.0",
  "info": {
    "name": "Solaris Zones Solaris Zone Administration API",
    "version": "1.6"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "_rad_session",
      "value": "{{_rad_session}}",
      "placement": "query"
    }
  },
  "items": [
    {
      "info": {
        "name": "Installation",
        "type": "folder"
      },
      "items": [
        {
          "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, provisioning its root file system and packages. Transitions the zone 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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Uninstall a zone, removing its root file system and installed content. The zone returns to the configured state. 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": "Install a zone by cloning from an existing zone or ZFS snapshot. The target zone must be in the configured state. Equivalent to zoneadm clone."
        }
      ]
    },
    {
      "info": {
        "name": "Lifecycle",
        "type": "folder"
      },
      "items": [
        {
          "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 an installed or ready zone, transitioning it to the running state. Equivalent to zoneadm boot."
        },
        {
          "info": {
            "name": "Solaris Zones Halt a Zone Immediately",
            "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 without running shutdown scripts. The zone transitions to the installed state. Equivalent to zoneadm halt."
        },
        {
          "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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Gracefully shut down a running zone by executing shutdown scripts and cleanly stopping services. 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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reboot a running zone. The zone is halted and then booted again. Equivalent to zoneadm reboot."
        },
        {
          "info": {
            "name": "Solaris Zones Prepare 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 the zone to the ready state where virtual platform and networking are set up but the zone is not yet booted. Equivalent to zoneadm ready."
        },
        {
          "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 to persistent storage for later resumption. The zone can be resumed by booting it."
        },
        {
          "info": {
            "name": "Solaris Zones Mark Zone to a Specified State",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/mark",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Forcefully mark a zone to a specific state when normal state transitions are not possible. Used for recovery. Equivalent to zoneadm mark."
        },
        {
          "info": {
            "name": "Solaris Zones Save Zone Core Dump",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/savecore",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Save a kernel crash dump from a zone. Equivalent to zoneadm savecore."
        }
      ]
    },
    {
      "info": {
        "name": "Migration",
        "type": "folder"
      },
      "items": [
        {
          "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 or a zone moved from another system. Validates and updates the zone configuration for the current system. 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, preparing it for migration to another system or for archival. The zone transitions to the configured state. Equivalent to zoneadm detach."
        },
        {
          "info": {
            "name": "Solaris Zones Move a Zone to a New Path",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/_rad_method/move",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Move a zone's root file system to a new location on the same system. Equivalent to zoneadm move."
        },
        {
          "info": {
            "name": "Solaris Zones Migrate 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 using either live or cold migration. Live migration keeps the zone running during transfer. Cold migration halts the zone first. Available since API version 1.1."
        }
      ]
    },
    {
      "info": {
        "name": "State Query",
        "type": "folder"
      },
      "items": [
        {
          "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 that the zone configuration is complete and correct. Checks resource dependencies and property validity. Equivalent to zoneadm verify."
        },
        {
          "info": {
            "name": "Solaris Zones Get Current 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 lifecycle state of the zone."
        },
        {
          "info": {
            "name": "Solaris Zones Get Zone Auxiliary States",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/api/com.oracle.solaris.rad.zonemgr/1.6/Zone/:zoneName/auxstate",
            "params": [
              {
                "name": "zoneName",
                "value": "",
                "type": "path",
                "description": "Name of the zone"
              }
            ]
          },
          "docs": "Retrieve auxiliary state information for the zone."
        }
      ]
    }
  ],
  "bundled": true
}