{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ignition Gateway REST access-control projects API",
    "version": "8.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Ignition-API-Token",
      "value": "{{X-Ignition-API-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new project on this Ignition Gateway."
        },
        {
          "info": {
            "name": "Copy Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/copy",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a copy of a project on this Ignition Gateway."
        },
        {
          "info": {
            "name": "Export Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/export/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Exports the given project as a zip archive."
        },
        {
          "info": {
            "name": "Project Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/find/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get information about a specific Ignition Project."
        },
        {
          "info": {
            "name": "Import Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/import/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "overwrite",
                "value": "",
                "type": "query",
                "description": "Set `true` to overwrite an existing project of the same name."
              }
            ]
          },
          "docs": "Import a project into this Ignition Gateway."
        },
        {
          "info": {
            "name": "List All Projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/list",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all runnable project on this Ignition Gateway."
        },
        {
          "info": {
            "name": "List All Project Names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/names",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List names of all projects on this Ignition Gateway."
        },
        {
          "info": {
            "name": "List All Valid Parent Projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/parents",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List names of all valid parent projects on this Ignition Gateway."
        },
        {
          "info": {
            "name": "List Valid Parent Project Names For Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/parents/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List names of valid parent projects for a given project on this Ignition Gateway."
        },
        {
          "info": {
            "name": "Rename Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/rename/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Rename a project on this Ignition Gateway."
        },
        {
          "info": {
            "name": "Modify Project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify an Ignition Project."
        },
        {
          "info": {
            "name": "Delete an Ignition Project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{gateway-host}:{port}/data/api/v1/projects/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion."
              }
            ]
          },
          "docs": "Delete a project from this Ignition Gateway."
        }
      ]
    }
  ],
  "bundled": true
}