{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ignition Gateway REST access-control entity API",
    "version": "8.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Ignition-API-Token",
      "value": "{{X-Ignition-API-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "entity",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Browse Entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/entity/browse",
            "params": [
              {
                "name": "path",
                "value": "",
                "type": "query",
                "description": "Path to a specific entity to browse. Use '/' to separate path components."
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "The depth to browse to. Default is 1."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "When listing children, the limit of children to return. Default is 10. Zero means unlimited"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "When listing children, the number of children to skip. Default is 0."
              }
            ]
          },
          "docs": "This endpoint returns a list of matching registered entities, including children up to the depth specified."
        },
        {
          "info": {
            "name": "Set Entity Enabled",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/entity/enabled",
            "params": [
              {
                "name": "path",
                "value": "",
                "type": "query",
                "description": "(Required) The path of the entity to enable or disable. Use '/' to separate path components."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "The maximum time to wait for the operation to complete, in seconds. Default is 10."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows for altering the enabled state of an entity"
        },
        {
          "info": {
            "name": "Entities by Section",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/entity/section/:section",
            "params": [
              {
                "name": "section",
                "value": "",
                "type": "path"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "The depth to browse to. Default is 1."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "When listing children, the limit of children to return. Default is 10. Zero means unlimited"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "When listing children, the number of children to skip. Default is 0."
              },
              {
                "name": "tag",
                "value": "",
                "type": "query",
                "description": "If specified, will only return entities that have the given tag. Can be specified multiple times."
              }
            ]
          },
          "docs": "Returns Entities relevant to a given UI section"
        }
      ]
    }
  ],
  "bundled": true
}