{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ignition Gateway REST access-control storage API",
    "version": "8.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Ignition-API-Token",
      "value": "{{X-Ignition-API-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "storage",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Delete temp folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/delete-temp-folder",
            "params": [
              {
                "name": "folderPath",
                "value": "",
                "type": "query",
                "description": "(Required) The path to the temporary folder. This folder path is relative to the EAM system temp folder."
              }
            ]
          },
          "docs": "Deletes the folder containing the previously uploaded files for an EAM task"
        },
        {
          "info": {
            "name": "Retrieve module certificate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/module-cert",
            "params": [
              {
                "name": "filePath",
                "value": "",
                "type": "query",
                "description": "(Required) The file path to the temporary .modl file"
              }
            ]
          },
          "docs": "Retrieves module certificate information from an uploaded .modl file"
        },
        {
          "info": {
            "name": "Accept module certificate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/module-cert",
            "params": [
              {
                "name": "filePath",
                "value": "",
                "type": "query",
                "description": "(Required) The file path to the temporary certificate file extracted from the .modl file"
              }
            ]
          },
          "docs": "Adds a resource to the controller indicating that the user has accepted a module certificate."
        },
        {
          "info": {
            "name": "Retrieve module EULA",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/module-eula",
            "params": [
              {
                "name": "filePath",
                "value": "",
                "type": "query",
                "description": "(Required) The file path to the temporary license.html file extracted from the .modl file"
              }
            ]
          },
          "docs": "Retrieves a module EULA from an uploaded .modl file. The EULA is returned as HTML."
        },
        {
          "info": {
            "name": "Accept module EULA",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/module-eula",
            "params": [
              {
                "name": "filePath",
                "value": "",
                "type": "query",
                "description": "(Required) The file path to the temporary license.html file extracted from the .modl file"
              },
              {
                "name": "moduleId",
                "value": "",
                "type": "query",
                "description": "(Required) The module id of the .modl file"
              }
            ]
          },
          "docs": "Adds a resource to the controller indicating that the user has accepted a module EULA."
        },
        {
          "info": {
            "name": "Upload .gwbk file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/store-gwbk"
          },
          "docs": "Uploads a .gwbk for temporary storage on the controller. The returned gwbk path is relative to the EAM system temp folder."
        },
        {
          "info": {
            "name": "Upload .modl file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/store-module",
            "params": [
              {
                "name": "filename",
                "value": "",
                "type": "query",
                "description": "(Required) Used as the filename when the .modl is uploaded to the gateway's file system. The file is stored in a temporary folder."
              }
            ]
          },
          "docs": "Uploads a .modl file for temporary storage on the controller. The returned modlFile path is relative to the EAM system temp folder."
        },
        {
          "info": {
            "name": "Store module file from archive",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/store-module-from-archive",
            "params": [
              {
                "name": "filePath",
                "value": "",
                "type": "query",
                "description": "(Required) The file path of the archived module file, as returned from the archived-modules endpoint. The file is stored in a temporary folder."
              }
            ]
          },
          "docs": "Adds an archived module file to temporary storage on the controller. The returned modlFile path is relative to the EAM system temp folder."
        },
        {
          "info": {
            "name": "Upload upgrade zip",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/eam-tasks/store-upgrade-zip"
          },
          "docs": "Upload an Ignition upgrade.zip for temporary storage on the controller. The returned filePath holds the path to the upgrade.zip and is relative to the EAM system temp folder."
        },
        {
          "info": {
            "name": "Retrieve archived backups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/storage/archived-backups",
            "params": [
              {
                "name": "serverids",
                "value": "",
                "type": "query",
                "description": "(Required) A comma-separated list of encoded ServerIds"
              }
            ]
          },
          "docs": "Retrieves a list of gateway backups for the specified agents. Returned file paths are relative to the EAM archive folder."
        },
        {
          "info": {
            "name": "Retrieve archived modules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/eam/api/v1/storage/archived-modules"
          },
          "docs": "Retrieves a list of modules archived on the EAM controller. Returned module file paths are relative to the EAM archive folder."
        }
      ]
    }
  ],
  "bundled": true
}