{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ignition Gateway REST access-control overview API",
    "version": "8.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Ignition-API-Token",
      "value": "{{X-Ignition-API-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "overview",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get All Available Locales",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/locales",
            "params": [
              {
                "name": "includeVariants",
                "value": "",
                "type": "query",
                "description": "Include local variants in results, defaults to true. When true, there will be multiple entries for some languages, `value` will include the variant code, and `label` will include the location name in parentheses.\nFor example French would include variants for France and for Canada (amongst others), resulting in codes with the format fr_FR, fr_CA, etc., and labels French (France) and French (Canada), etc."
              }
            ]
          },
          "docs": "Returns codes and display names for all languages available for use by the gateways."
        },
        {
          "info": {
            "name": "Gateway Overview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/overview"
          },
          "docs": "General status information about this Ignition Gateway."
        },
        {
          "info": {
            "name": "Connections Overview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/overview/connections",
            "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": "A list of various connections (DB, OPC, etc.) on this Ignition Gateway."
        },
        {
          "info": {
            "name": "Gateway Network",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/overview/gan"
          },
          "docs": "Information about the Gateway Network."
        },
        {
          "info": {
            "name": "Gateway Name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/overview/name"
          },
          "docs": "This Ignition Gateway's name."
        },
        {
          "info": {
            "name": "Problems Overview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/overview/problems",
            "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": "A list of objects representing problems on the gateway that are considered 'critical'"
        }
      ]
    }
  ],
  "bundled": true
}