mapr.json

{
  "swagger": "2.0", 
  "info": {
    "title": "MapR API", 
    "description": "The information about the MapR REST API", 
    "contact": {
      "url": "http://maprdocs.mapr.com"
    }, 
    "version": "5.2"
  }, 
  "basePath": "/rest", 
  "schemes": [
    "https"
  ], 
  "produces": [
    "application/json"
  ], 
  "paths": {
    "/acl/edit": {
      "get": {
        "tags": [
          "acl"
        ], 
        "summary": "Modifies a specific user's access to a cluster or volume.", 
        "description": "The `acl edit` command grants one or more specific volume or cluster permissions to a user. To use the `acl edit` command, you must have administrative (a) permissions on the volume and cluster for which you are running the command. The permissions are specified as a comma-separated list of permission codes. See [acl](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html). You must specify either a `user` or a `group`. When the `type` is `volume`, a volume name must be specified using the `name` parameter.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/acl-edit.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "group", 
            "in": "query", 
            "description": "Groups and allowed actions for each group. See [acl](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html). Format: `<group>:<action>[,<action>...][ <group>:<action>[,<action...]]`", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The object name.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The object type (`cluster` or `volume`).", 
            "required": true, 
            "type": "string", 
            "enum": [
              "cluster", 
              "volume"
            ]
          }, 
          {
            "name": "user", 
            "in": "query", 
            "description": "Users and allowed actions for each user. See [acl](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html). Format: `<user>:<action>[,<action>...][ <user>:<action>[,<action...]]`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/acl/set": {
      "get": {
        "tags": [
          "acl"
        ], 
        "summary": "Modifies the ACL for a cluster or volume.", 
        "description": "The `acl set` command specifies the entire ACL for a cluster or volume. Any previous permissions are overwritten by the new values, and any permissions omitted are removed. To use the `acl set` command, you must have administrative (a) permissions on the volume and cluster for which you are running the command. The permissions are specified as a comma-separated list of permission codes. See [acl](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html). You must specify either a `user` or a `group`. When the `type` is `volume`, a volume name must be specified using the `name` parameter.\n\n \n\nNote: The `acl set` command removes any previous ACL values. If you wish to preserve some of the permissions, you should either use the  [`acl edit`](http://maprdocs.mapr.com/home/ReferenceGuide/acl-edit.html)  command instead of `acl set`, or use  [`acl show`](http://maprdocs.mapr.com/home/ReferenceGuide/acl-show.html)  to list the values before overwriting them.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/acl-set.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "group", 
            "in": "query", 
            "description": "Groups and allowed actions for each group. See [acl](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html). Format: `<group>:<action>[,<action>...][ <group>:<action>[,<action...]]`", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The object name.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The object type (`cluster` or `volume`).", 
            "required": true, 
            "type": "string", 
            "enum": [
              "cluster", 
              "volume"
            ]
          }, 
          {
            "name": "user", 
            "in": "query", 
            "description": "Users and allowed actions for each user. See [acl](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html). Format: `<user>:<action>[,<action>...][ <user>:<action>[,<action...]]`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/acl/show": {
      "get": {
        "tags": [
          "acl"
        ], 
        "summary": "Displays the ACL associated with an object (cluster or a volume).", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/acl-show.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "group", 
            "in": "query", 
            "description": "The group for which to display permissions.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The cluster or volume name.", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "The output format:\n\n \n \n* long \n* short \n* terse", 
            "type": "string", 
            "enum": [
              "long", 
              "short", 
              "terse"
            ]
          }, 
          {
            "name": "perm", 
            "in": "query", 
            "description": "When this option is specified, `acl show` displays the permissions available for the object type specified in the `type` parameter.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "Value can be: `cluster` or `volume`.", 
            "required": true, 
            "type": "string", 
            "enum": [
              "cluster", 
              "volume"
            ]
          }, 
          {
            "name": "user", 
            "in": "query", 
            "description": "The user for which to display permissions", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/clear": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Clears one or more alarms. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-clear.html"
        }, 
        "parameters": [
          {
            "name": "alarm", 
            "in": "query", 
            "description": "The named alarm to clear. See [Alarm Types](http://maprdocs.mapr.com/home/ReferenceGuide/alarm.html).", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "entity", 
            "in": "query", 
            "description": "The entity on which to clear the alarm.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/clearall": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Clears all alarms. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-clearall.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/config/load": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Displays the configuration of alarm notifications. Permission required: login", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-config-load.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Whether the output should be terse or verbose.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/config/save": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Sets notification preferences for alarms. Permissions required: fc or a .", 
        "description": "Alarm notifications can be sent to the default email address and a specific email address for each named alarm. If `individual` is set to `1` for a specific alarm, then notifications for that alarm are sent to the default email address for the alarm type. If a custom email address is provided, notifications are sent there regardless of whether they are also sent to the default email address.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-config-save.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "values", 
            "in": "query", 
            "description": "A comma-separated list of configuration values for one or more alarms, in the following format: `<alarm>,<individual>,<email>` See [Alarm Notification Fields](http://maprdocs.mapr.com/home/ReferenceGuide/alarm.html).", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/list": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Lists alarms in the system. Permissions required: login .", 
        "description": "You can list all alarms, alarms by type (Cluster, Node or Volume), or alarms on a particular node or volume. To retrieve a count of all alarm types, pass `1` in the `summary` parameter. You can specify the alarms to return by filtering on type and entity. Use `start` and `limit` to retrieve only a specified window of data.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-list.html"
        }, 
        "parameters": [
          {
            "name": "alarm", 
            "in": "query", 
            "description": "The alarm name for which to return information.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to list alarms.", 
            "type": "string"
          }, 
          {
            "name": "entity", 
            "in": "query", 
            "description": "The name of the cluster, node, volume, user, or group to check for alarms.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of records to retrieve. Default: 2147483647", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Whether the output should be terse or verbose. Default: 0", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The list offset at which to start. Default: 0.", 
            "type": "string"
          }, 
          {
            "name": "summary", 
            "in": "query", 
            "description": "Specifies the type of data to return:\n \n* 1 = count by alarm type \n* 0 = List of alarms \n\n Default: 0", 
            "type": "boolean", 
            "enum": [
              "1", 
              "0"
            ]
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The entity type:\n\n \n \n*  `cluster`  \n*  `node`  \n*  `volume`  \n*  `ae`", 
            "type": "string", 
            "enum": [
              "cluster", 
              "node", 
              "volume", 
              "AE"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/names": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Displays a list of alarm names. Permissions required: login", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-names.html"
        }, 
        "parameters": [], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/alarm/raise": {
      "get": {
        "tags": [
          "alarm"
        ], 
        "summary": "Raises a specified alarm or alarms. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/alarm-raise.html"
        }, 
        "parameters": [
          {
            "name": "alarm", 
            "in": "query", 
            "description": "The alarm type to raise. See [Alarm Types](http://maprdocs.mapr.com/home/ReferenceGuide/alarm.html).", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "description", 
            "in": "query", 
            "description": "A brief description.", 
            "type": "string"
          }, 
          {
            "name": "entity", 
            "in": "query", 
            "description": "The entity on which to raise alarms.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/audit/cluster": {
      "get": {
        "tags": [
          "audit"
        ], 
        "summary": "Enables and disables auditing of operations that are related to the administration of a MapR cluster.", 
        "description": "Only the `mapr` user for the cluster can run this command. For more information about the mapr user, see [Managing Users and Groups](http://maprdocs.mapr.com/home/AdministratorGuide/c-managing-users-and-groups.html#Managing-Users-and-Groups-rootisusedtoinstallM-d3e62).\n\n \n\nFor information about auditing cluster-administration operations, see [Auditing of Activity Related to Cluster Administration](http://maprdocs.mapr.com/home/SecurityGuide/AuditingClusterAdminActivity.html#AuditingofActivityRelatedtoClusterAdministration).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/audit-cluster.html"
        }, 
        "parameters": [
          {
            "name": "enabled", 
            "in": "query", 
            "description": "The value `true` enables auditing, the value `false` disables it.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/audit/data": {
      "get": {
        "tags": [
          "audit"
        ], 
        "summary": "Enables and disables auditing of filesystem and table operations.", 
        "description": "For a list of these operations, see [Auditing of Filesystem Operations and Table Operations](http://maprdocs.mapr.com/home/SecurityGuide/Auditing-FilesystemTableOperations.html#AuditingofFilesystemOperationsandTableOperations).\n\n \n\nOnly the `mapr` user for the cluster can run this command. For more information about the mapr user, see [Managing Users and Groups](http://maprdocs.mapr.com/home/AdministratorGuide/c-managing-users-and-groups.html).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/audit-data.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The path and name of a remote MapR cluster.", 
            "type": "string"
          }, 
          {
            "name": "enabled", 
            "in": "query", 
            "description": "The value `true` enables auditing, the value `false` disables it.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "maxsize", 
            "in": "query", 
            "description": "The size in GB at which an alarm is sent to the dashboard in the MapR Control Service. The alarm is to notify the cluster administrator that the audit log is becoming large enough that the administrator might want to take action. For more information about this parameter, the alarm, and possible actions to take, see [Managing Audit Logs for Filesystem and Table Operations](http://maprdocs.mapr.com/home/SecurityGuide/ManagingAuditLogs-FS-DB-Operations.html#ManagingAuditLogsforFilesystemandTableOperations). \n\nThe audit log continues to grow until the administrator takes action or until the retention period ends.\n\n \n\nThe default value is 32.", 
            "type": "string"
          }, 
          {
            "name": "retention", 
            "in": "query", 
            "description": "The period of time in days for which to keep the data in the audit log for the data access. After this period elapses, the content of the file is deleted and new entries are added to the file until the next retention period elapses.", 
            "type": "string"
          }, 
          {
            "name": "coalesce", 
            "in": "query", 
            "description": "Sets an interval during which READ, WRITE, or GETATTR operations on one file from one client IP address are logged only once.\n\nFor example, suppose that a client application reads a single file three times in 6 minutes, so that there is one read at 0 minutes, another at 3 minutes, and a final read at 6 minutes. If the coalesce interval is at least 6 minutes, then only the first read operation is logged. However, if the interval is between 4 minutes, then only the first and third read operations are logged. If the interval is 2 minutes, all three read operations are logged.\n\n \n\nYou can set this interval on individual volumes. The default value is 60 minutes. Setting this field to a larger number helps prevent audit logs from growing quickly.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/audit/info": {
      "get": {
        "tags": [
          "audit"
        ], 
        "summary": "Displays whether auditing of cluster-management operations and auditing data-access operations are enabled. Also, displays the maxSize and retention values for these two levels of auditing.", 
        "description": "Only the `mapr` user for the cluster can run this command. For more information about the `mapr` user, see [Managing Users and Groups](http://maprdocs.mapr.com/home/AdministratorGuide/c-managing-users-and-groups.html#Managing-Users-and-Groups-rootisusedtoinstallM-d3e62).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/audit-info.html"
        }, 
        "parameters": [], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/gateway/delete": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Deletes the list of MapR gateways from a source MapR cluster.", 
        "description": "Source MapR clusters can use such lists to locate the gateways that enable replication of table data to a particular MapR cluster or indexing of table data in a particular Elasticsearch cluster. You create lists of gateways by running the `maprcli cluster gateway set` command.\n\n \n\nThere are three methods of specifying the location of gateways to a MapR cluster that is a source for table replication or indexing in Elasticsearch. If a source MapR cluster relies on DNS records to find out where gateways are located, or the cluster relies on the `mapr-clusters.conf` file to locate gateways, there is no list for the cluster gateway delete command to delete. \n\n \n\nNote: Deleting a list of gateways with the `maprcli cluster gateway delete` command does not uninstall the listed gateways from the MapR cluster where they are located.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-gateway-delete.html"
        }, 
        "parameters": [
          {
            "name": "dstcluster", 
            "in": "query", 
            "description": "The name of the cluster on which the gateways are located.\n\n \n\nIf you are replicating table data to another MapR cluster, specify the name of that destination cluster. This destination cluster could be the source cluster if you are performing intracluster replication.\n\n \n\nIf you are indexing table data in an Elasticsearch cluster, specify the name of the source MapR cluster because that is where the gateways are located.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "If you are not on the source cluster, provide the name of the source cluster that this command should be run on,", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/gateway/get": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Lists the MapR gateways that a source MapR cluster is using.", 
        "description": "The source MapR cluster could be using the MapR gateways either for replication of table data to a destination MapR cluster or for the indexing of data in an Elasticsearch cluster.\n\n \n\nThis list of gateways is created by the `maprcli cluster gateway set` command.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-gateway-get.html"
        }, 
        "parameters": [
          {
            "name": "dstcluster", 
            "in": "query", 
            "description": "The name of the cluster on which the gateways are located.\n\n \n\nIf you are replicating table data to another MapR cluster, specify the name of that destination cluster. This destination cluster could be the source cluster if you are performing intracluster replication.\n\n \n\nIf you are indexing table data in an Elasticsearch cluster, specify the name of the source MapR cluster because that is where the gateways are located.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "If you are not on the source cluster, provide the name of the source cluster that this command should be run on.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/gateway/list": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Lists all of the gateways that a source MapR cluster is using.", 
        "description": "The source MapR cluster is using gateways either for replication of table data to destination MapR clusters or for the indexing of table data in Elasticsearch clusters.\n\n \n\nThis list is created by the `maprcli cluster gateway set` command.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-gateway-list.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "If you are not on the source cluster, provide the name of the source cluster that this command should be run on.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/gateway/local": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Lists the gateways that are configured on the MapR cluster where this command is run.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-gateway-local.html"
        }, 
        "parameters": [
          {
            "name": "format", 
            "in": "query", 
            "description": "The output format. Value types: `dns` or `text`. Default: `text`. \n\nNote: \n \n* If the output is formatted as DNS, you can copy and paste the output into a DNS record in the zone file for your domain. The source MapR cluster can then locate the gateways by doing a DNS lookup. \n* If the output is formatted as text, you can copy and paste that text into the `-gateways` parameter of the `maprcli cluster gateway set` command. Running this command is an alternative way of specifying the location of these gateways to the source MapR cluster.", 
            "type": "string", 
            "enum": [
              "dns", 
              "text"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "If you are not on a MapR cluster where one or more gateways are configured, provide the name of the cluster. \n \n* When replicating MapR-DB table data to one or more replicas on this cluster, then the cluster is a destination MapR cluster. \n* When indexing MapR-DB table data in one or more Elasticsearch cluster, then the current cluster is a source MapR cluster where the tables being indexed are located.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/gateway/resolve": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Lists the gateways configured on MapR cluster that are up and running at the time that the command is issued.", 
        "description": "Execute this command on a source MapR cluster to find out how many gateways are available for table replication to a destination MapR cluster or for indexing table data in an Elasticsearch cluster.\n\n \n\nThis command uses the following criteria to get the list:\n\n \n \n*  \n\nIf the locations of the gateways were specified with the `marpcli cluster gateway set` command, the maprcli cluster gateway resolve command returns the list of the gateways.\n\n  \n*  \n\nIf the locations of the gateways were specified with a DNS record only, this command performs a DNS lookup for gateways on the specified MapR cluster and returns the list that it finds.\n\n  \n*  \n\nIf neither of the previous methods was used to specify the locations of the gateways, this command assumes that gateways are located on the CLDB nodes configured in the `mapr-clusters.conf` file on the MapR cluster where the command is executed.\n\n  \n\n \n\nNote: Unresponsive gateways are not included in the list.\n\n \n\nFor more information about gateways, see [ MapR Gateways](http://maprdocs.mapr.com/home/Gateways/MapRGateways.html).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-gateway-resolve.html"
        }, 
        "parameters": [
          {
            "name": "dstcluster", 
            "in": "query", 
            "description": "The name of the cluster for which you want to list the available gateways.\n\n \n\nIf you are replicating table data to another MapR cluster, specify the name of that destination cluster. This destination cluster could be the source cluster if you are performing intracluster replication.\n\n \n\nIf you are indexing table data in an Elasticsearch cluster, specify the name of the source MapR cluster because that is where the gateways are located.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "If you are not on the source MapR cluster, provide the name of the source cluster that this command should be run on.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/gateway/set": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Specifies the locations of the MapR gateways that a source MapR cluster can use for table replication to a destination MapR cluster or for indexing table data in an Elasticsearch cluster.", 
        "description": "In addition to this method, there are two other methods that you can use to specify the locations of gateways that a source MapR cluster can use when replicating to a particular MapR cluster or when indexing in an Elasticsearch cluster. See [Configuring a MapR Gateway Master-Slave Topology](http://maprdocs.mapr.com/home/Gateways/ConfiguringMapRGatewaysForTRAndI.html) for details about them.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-gateway-set.html"
        }, 
        "parameters": [
          {
            "name": "dstcluster", 
            "in": "query", 
            "description": "The name of the MapR cluster in which the gateways are located.\n\n \n\nIf you are replicating table data to another MapR cluster, specify the name of that destination cluster. This destination cluster could be the source cluster if you are performing intracluster replication.\n\n \n\nIf you are indexing table data in an Elasticsearch cluster, specify the name of the source MapR cluster because that is where the gateways are located.", 
            "type": "string"
          }, 
          {
            "name": "gateways", 
            "in": "query", 
            "description": "A space-delimited list of gateway hostnames or IP addresses. Place double quotation marks around the list of gateways, as in this example: `-gateways \"gateway1 gateway2\"`", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "If you are not on the source MapR cluster, provide the name of that cluster.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/mapreduce/get": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Displays the cluster-wide default for the MapReduce mode.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-mapreduce-get.html"
        }, 
        "parameters": [], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/cluster/mapreduce/set": {
      "get": {
        "tags": [
          "cluster"
        ], 
        "summary": "Sets the cluster-wide MapReduce mode.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/cluster-mapreduce-set.html"
        }, 
        "parameters": [
          {
            "name": "mode", 
            "in": "query", 
            "description": "The MapReduce mode of the cluster. Enter one of the following:\n\n \n \n*  `classic`: Use JobTracker and TaskTracker to run MapReduce Jobs. \n*  `yarn`: Use Resource Manager and Node Manager to run MapReduce jobs or applications.", 
            "type": "string", 
            "enum": [
              "yarn", 
              "classic"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/config/load": {
      "get": {
        "tags": [
          "config"
        ], 
        "summary": "Displays information about the cluster configuration.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/config-load.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster for which to display values.", 
            "type": "string"
          }, 
          {
            "name": "keys", 
            "in": "query", 
            "description": "This parameter is used to specify which information to display. Comma-separated fields are used to display values; see the [Configuration Fields](http://maprdocs.mapr.com/home/ReferenceGuide/config.html) table.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/config/save": {
      "get": {
        "tags": [
          "config"
        ], 
        "summary": "Saves configuration information, specified as key/value pairs. Permissions required: fc or a .", 
        "description": "See the [Configuration Fields](http://maprdocs.mapr.com/home/ReferenceGuide/config.html) table.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/config-save.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "values", 
            "in": "query", 
            "description": "A JSON object containing configuration fields; see the [Configuration Fields](http://maprdocs.mapr.com/home/ReferenceGuide/config.html) table.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/dashboard/info": {
      "get": {
        "tags": [
          "dashboard info"
        ], 
        "summary": "Displays a summary of information about the cluster.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/dashboard-info.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "multi_cluster_info", 
            "in": "query", 
            "description": "Specifies whether to display cluster information from multiple clusters. \n\n \n\nValues: true/false. Default: false", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "version", 
            "in": "query", 
            "description": "Specifies whether to display the version. Values: true/false. Default: false", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "zkconnect", 
            "in": "query", 
            "description": "[ZooKeeper Connect String](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-CommonParameters.html#concept_ymb_yxz_5t)", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/dialhome/ackdial": {
      "get": {
        "tags": [
          "dialhome"
        ], 
        "summary": "Acknowledges the most recent Dial Home on the cluster. Permissions required: login", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/dialhome-ackdial.html"
        }, 
        "parameters": [
          {
            "name": "forDay", 
            "in": "query", 
            "description": "Date for which the recorded metrics were successfully dialed home. Accepted values: UTC timestamp or a UTC date in MM/DD/YY format. Default: yesterday", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/dialhome/enable": {
      "get": {
        "tags": [
          "dialhome"
        ], 
        "summary": "Enables Dial Home on the cluster. Permissions required: fc or a", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/dialhome-enable.html"
        }, 
        "parameters": [
          {
            "name": "enable", 
            "in": "query", 
            "description": "Specifies whether to enable or disable Dial Home:\n\n \n \n* 0 - Disable \n* 1 - Enable", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/dialhome/lastdialed": {
      "get": {
        "tags": [
          "dialhome"
        ], 
        "summary": "Displays the date of the last successful Dial Home call. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/dialhome-lastdialed.html"
        }, 
        "parameters": [], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/dialhome/metrics": {
      "get": {
        "tags": [
          "dialhome"
        ], 
        "summary": "Returns a compressed metrics object. Permissions required: login.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/dialhome-metrics.html"
        }, 
        "parameters": [
          {
            "name": "forDay", 
            "in": "query", 
            "description": "Date for which the recorded metrics were successfully dialed home. Accepted values: UTC timestamp or a UTC date in MM/DD/YY format. Default: yesterday", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/dialhome/status": {
      "get": {
        "tags": [
          "dialhome"
        ], 
        "summary": "Displays the Dial Home status. Permissions required: login.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/dialhome-status.html"
        }, 
        "parameters": [], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/disk/add": {
      "get": {
        "tags": [
          "disk"
        ], 
        "summary": "Adds one or more disks to the specified node. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/disk-add.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to add disks. If not specified, the default is the current cluster.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "stripeWidth", 
            "in": "query", 
            "description": "The number of disks per storage pool.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "disks", 
            "in": "query", 
            "description": "A comma-separated list of disk names. Examples:\n\n \n \n*  /dev/sdc \n*  /dev/sdd,/dev/sde,/dev/sdf", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "host", 
            "in": "query", 
            "description": "The hostname or IP address of the machine on which to add the disk.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/disk/list": {
      "get": {
        "tags": [
          "disk"
        ], 
        "summary": "Lists the disks on a node.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/disk-list.html"
        }, 
        "parameters": [
          {
            "name": "host", 
            "in": "query", 
            "description": "The node on which to list the disks.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Whether the output should be `terse` or `verbose`. Default is `verbose`.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "system", 
            "in": "query", 
            "description": "Show only operating system disks:\n\n \n \n* 0 - shows only MapR-FS disks \n* 1 - shows only operating system disks \n* Not specified - shows both MapR-FS and operating system disks", 
            "type": "string", 
            "enum": [
              "1", 
              "0"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/disk/listall": {
      "get": {
        "tags": [
          "disk"
        ], 
        "summary": "Lists all disks.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/disk-listall.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of rows to return, beginning at start. Default: 0", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Always the string `terse`.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The offset from the starting row according to sort. Default: 0", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/disk/remove": {
      "get": {
        "tags": [
          "disk"
        ], 
        "summary": "Removes a disk from MapR-FS. Permissions required: fc or a .", 
        "description": "The `disk remove` command does not remove a disk containing unreplicated data unless forced. To force disk removal, specify `-force` with the value `1`.\n\n \n\nNote: \n \n* Only use the `-force 1` option if you are sure that you do not need the data on the disk. This option removes the disk without regard to replication factor or other data protection mechanisms, and may result in permanent data loss. \n* Removing a disk in the storage pool that contains Container ID 1 will stop your cluster. Container ID 1 contains CLDB data for the master CLDB. Run `disk remove` without the `-force 1` option first and examine the warning messages to make sure you aren't removing the disk with Container ID 1. If you try to remove a disk associated with the storage pool that contains Container ID 1, you will see an error message similar to the following: \n\n```\nERROR (151) -  Failed operation for disk /dev/sdb, Operation may bring \ndown cluster due to loss of cluster meta-data.\n```\n\n If necessary, run the following command for information on the disk associated with the storage pool that contains Container ID 1: \n\n```\n/opt/mapr/server/mrconfig info dumpcontainers  | grep cid:1\n```\n\n The command output may look similar to the following: \n\n```\ncid:1 volid:1 sp:SP1:/dev/sdb spid:82380c287085486f0058112ecf016b76 \nprev:0 next:0 issnap:0 isclone:0 deleteinprog:0 fixedbyfsck:0 stale:0 \nquerycldb:0 resyncinprog:0 shared:0 owned:206 logical:206 snapusage:0 \nsnapusageupdated:1 ismirror:0 isrwmirrorcapable:0 role:1 maxUniq:2100150 \nisResyncSnapshot:0 snapId:0 port:5660\n```\n\n To safely remove such a disk, perform a [CLDB Failover](http://maprdocs.mapr.com/home/AdministratorGuide/CLDB-Failover.html#CLDB-Failover-TheCLDBserviceautoma-d3e78) to make one of the other CLDB nodes the primary CLDB, then remove the disk as normal.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/disk-remove.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "disks", 
            "in": "query", 
            "description": "A list of disks in the form:\n\n \n\n```\n[\"disk\"]or[\"disk\",\"disk\",\"disk\"...]or[]\n```", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "force", 
            "in": "query", 
            "description": "Whether to force\n\n \n \n*  `0` (default) - do not remove the disk or disks if there is unreplicated data on the disk \n*  `1` - remove the disk or disks regardless of data loss or other consequences", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "host", 
            "in": "query", 
            "description": "The hostname or ip address of the node from which to remove the disk.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/entity/info": {
      "get": {
        "tags": [
          "entity"
        ], 
        "summary": "Displays information about an entity.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/entity-info.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The entity name. Obtain the entity name by running the `maprcli entity list` command.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Whether to display terse or verbose output.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The entity type. Obtain the entity type by running the `maprcli entity list` command.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/entity/list": {
      "get": {
        "tags": [
          "entity"
        ], 
        "summary": "Lists and displays information about entities.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/entity-list.html"
        }, 
        "parameters": [
          {
            "name": "alarmedentities", 
            "in": "query", 
            "description": "Specifies whether to list only entities that have exceeded a quota or advisory quota.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of fields to return in the query. See the Fields table below.", 
            "type": "string"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying entities to display. See [Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) for more information.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of rows to return, beginning at start. Default: 0", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Specifies whether output should be `terse` or `verbose`.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The offset from the starting row according to sort. Default: 0", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/entity/modify": {
      "get": {
        "tags": [
          "entity"
        ], 
        "summary": "Modifies a user or group quota or email address. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/entity-modify.html"
        }, 
        "parameters": [
          {
            "name": "advisoryquota", 
            "in": "query", 
            "description": "The advisory quota.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "email", 
            "in": "query", 
            "description": "Email address.", 
            "type": "string"
          }, 
          {
            "name": "entities", 
            "in": "query", 
            "description": "A comma-separated list of entities, in the format `<type>:<name>`. Example: `0:<user1>,0:<user2>,1:<group1>,1:<group2>...`", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The entity name.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "quota", 
            "in": "query", 
            "description": "The quota for the entity.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The entity type:\n\n \n \n* 0=user \n* 1-group", 
            "required": true, 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/entity/remove": {
      "get": {
        "tags": [
          "entity"
        ], 
        "summary": "Removes an entity (specified by name and type).", 
        "description": "Note: Entity can be removed only when there are no resources associated with the entity.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/entity-remove.html"
        }, 
        "parameters": [
          {
            "name": "name", 
            "in": "query", 
            "description": "The entity name. Obtain the entity name by running the `maprcli entity list` command.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The entity type. Value can be: \n \n* `0` - for user \n* `1` - for group \n\n If necessary, obtain the entity type by running the `maprcli entity list` command.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/job/changepriority": {
      "get": {
        "tags": [
          "job"
        ], 
        "summary": "Changes the priority of the specified job.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/job-changepriority.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "Cluster name", 
            "type": "string"
          }, 
          {
            "name": "jobid", 
            "in": "query", 
            "description": "Job ID", 
            "type": "string"
          }, 
          {
            "name": "priority", 
            "in": "query", 
            "description": "New job priority", 
            "type": "string", 
            "enum": [
              "NORMAL", 
              "LOW", 
              "VERY_LOW", 
              "HIGH", 
              "VERY_HIGH"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/job/kill": {
      "get": {
        "tags": [
          "job"
        ], 
        "summary": "Kills a specified job.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/job-kill.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "Cluster name", 
            "type": "string"
          }, 
          {
            "name": "jobid", 
            "in": "query", 
            "description": "Job ID", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/job/linklogs": {
      "get": {
        "tags": [
          "job"
        ], 
        "summary": "Creates symbolic links to all the logs relating to the activity of a specific job.", 
        "description": "The `maprcli job linklogs` command works with the [Centralized Logging](http://maprdocs.mapr.com/home/AdministratorGuide/Centralized-Logging.html#Centralized-Logging-MapRsCentralizedLog-d3e72) to provide a job-centric view or an application-centric view of all log files generated during job or application execution.\n\n \n\n The output of `job linklogs` is a directory populated with symbolic links to all log files related to the specified job(s) or to the application. The command can be performed during or after a job or application is processed.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/job-linklogs.html"
        }, 
        "parameters": [
          {
            "name": "jobid", 
            "in": "query", 
            "description": "* For MapReduce v1, specify a regular expression specifying the target jobs. To specify a pattern, you can use asterisks. You can prefix a pattern with `job;` otherwise, `job` will be automatically prepended to the pattern. There is just one match if the full job ID is used. \n* For MapReduce v2, specify the application ID.", 
            "type": "string"
          }, 
          {
            "name": "todir", 
            "in": "query", 
            "description": "The target directory for the symbolic links to the log files.", 
            "type": "string"
          }, 
          {
            "name": "jobconf", 
            "in": "query", 
            "description": "* For MapReduce v1 jobs, specify this parameter if the centralized job history location has changed since the job of interest was run. This command uses the centralized job history location specified by `mapred.job.tracker.history.completed.location.` The centralized job history location is by default `/var/mapr/cluster/mapred/jobTracker/history/done`. \n* For MapReduce v2, this parameter is not applicable.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/job/table": {
      "get": {
        "tags": [
          "job"
        ], 
        "summary": "Retrieves detailed information about the jobs running on the cluster including histograms and line charts for job metrics.", 
        "description": "A Hadoop job sets the rules that the JobTracker service uses to break an input data set into discrete tasks and assign those tasks to individual nodes. Use the `job table` command to retrieve [job metrics](http://maprdocs.mapr.com/home/AdministratorGuide/JobMetrics-Analyzing.html#Analyzing-Job-Metrics-TheMapRMetricsservic-d3e72) about the jobs running on your cluster. The job metric data includes the number of task attempts for jobs on the cluster, job duration, job computing resource use (CPU and memory), and job data throughput (both records and bytes per second). The metrics data can be formatted for histogram display or line chart display. In order to issue the `job table` command, the mapr-metrics package must be installed on all the nodes where webserver and jobtracker are configured to run.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/job-table.html"
        }, 
        "parameters": [
          {
            "name": "filter", 
            "in": "query", 
            "description": "Filters results to match the value of a specified string.", 
            "type": "string"
          }, 
          {
            "name": "chart", 
            "in": "query", 
            "description": "Chart type to use: `line` for a line chart, `bar` for a histogram.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "Comma-separated list of column names to return.", 
            "type": "string"
          }, 
          {
            "name": "bincount", 
            "in": "query", 
            "description": "Number of histogram bins.", 
            "type": "string"
          }, 
          {
            "name": "scale", 
            "in": "query", 
            "description": "Scale to use for the histogram. Specify `linear` for a linear scale and `log` for a logarithmic scale.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/add": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Adds a license. Permissions required: fc or a .", 
        "description": "The license can be specified either by passing the license string itself to `license add`, or by specifying a file containing the license string.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-add.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "is_file", 
            "in": "query", 
            "description": "Specifies whether the `license` specifies a file. If `false`, the `license` parameter contains a long license string.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "license", 
            "in": "query", 
            "description": "The license to add to the cluster. If `-is_file` is true, `license` specifies the filename of a license file. Otherwise, `license` contains the license string itself.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/addcrl": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Adds a certificate revocation list (CRL). Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-addcrl.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "crl", 
            "in": "query", 
            "description": "The CRL to add to the cluster. If file is set, crl specifies the filename of a CRL file. Otherwise, crl contains the CRL string itself.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "is_file", 
            "in": "query", 
            "description": "Specifies whether the license is contained in a file.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/apps": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Displays the features authorized for the current license. Permissions required: login", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-apps.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/list": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Lists licenses on the cluster. Permissions required: login. For best results, use the -json option when running the command.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-list.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/listcrl": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Lists certificate revocation lists (CRLs) on the cluster. Permissions required: login .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-listcrl.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/remove": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Removes a license. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-remove.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "license_id", 
            "in": "query", 
            "description": "The license to remove. Use the `license showid` command to obtain the license ID.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/license/showid": {
      "get": {
        "tags": [
          "license"
        ], 
        "summary": "Displays the cluster ID for use when creating a new license. Permissions required: login .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/license-showid.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/nagios/generate": {
      "get": {
        "tags": [
          "nagios generate"
        ], 
        "summary": "Generates a Nagios Object Definition file that describes the cluster nodes and the services running on each.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/nagios-generate.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/allow-into-cluster": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Allows host IDs to join the cluster after duplicates have been resolved.", 
        "description": "When the CLDB detects duplicate nodes with the same host ID, all nodes with that host ID are removed from the cluster and prevented from joining it again. After making sure that all nodes have unique host IDs, you can use the `node allow-into-cluster` command to un-ban the host ID that was previously duplicated among several nodes.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-allow-into-cluster.html"
        }, 
        "parameters": [
          {
            "name": "hostids", 
            "in": "query", 
            "description": "A comma-separated list of host IDs.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/cldbmaster": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Returns the address of the master CLDB node.", 
        "description": "The `node cldbmaster` API returns the server ID and hostname of the node serving as the CLDB master node.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-cldbmaster.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster for which to return the CLDB master node information.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/failover": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Fails over master containers and VIPs to another node.", 
        "description": "When this command runs, all master and intermediate containers are moved off the node and VIPs are re-assigned.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-failover.html"
        }, 
        "parameters": [
          {
            "name": "nodes", 
            "in": "query", 
            "description": "The hostname of the node going down.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/heatmap": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Displays a heatmap for the specified nodes.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-heatmap.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying snapshots to preserve. See [ Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax.html) for more information.", 
            "type": "string"
          }, 
          {
            "name": "view", 
            "in": "query", 
            "description": "Name of the heatmap view to show:\n\n \n \n*  `status` = Node status (the default view):  \n  *  `0` = Healthy \n  *  `1` = Needs attention \n  *  `2` = Degraded \n  *  `3` = Maintenance \n  *  `4` = Critical   \n*  `cpu` = CPU utilization, as a percent from 0-100. \n*  `memory` = Memory utilization, as a percent from 0-100.  \n*  `diskspace` = MapR-FS disk space utilization, as a percent from 0-100.  \n*  `NODE_*` = Status of various alarms: `0` if clear, `1` if raised. For example: `NODE_ALARM_DISK_FAILURE` or `NODE_ALARM_SERVICE_CLDB_DOWN`. You can return a complete list of supported alarm parameters by running: \n\n `maprcli node heatmap -view` \n\n \n\nSee the lists of parameters below this table.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/list": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Lists nodes in the cluster.", 
        "description": "You can specify a set of nodes for which to retrieve information in several ways:\n\n \n \n* To list only nodes with raised alarms, set `alarmednodes` to 1. \n* To list only NFS nodes, set `nfsnodes` to 1. \n* To window the list, use the `start` and `limit` options to select only a portion of the results. \n* To list nodes that match certain criteria, pass a filter to the `filter` parameter. See the Fields table on the [node](http://maprdocs.mapr.com/home/ReferenceGuide/node.html) page for the fields available to filter. See the [maprcli and REST API Syntax](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) page for information on filters.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-list.html"
        }, 
        "parameters": [
          {
            "name": "alarmednodes", 
            "in": "query", 
            "description": "If set to 1, displays only nodes with raised alarms. Cannot be used if `nfsnodes` is set.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of fields to return in the query, specified by the short names. Note: When specifying this option, the `ip` and `hostname` columns are always returned in the query.", 
            "type": "array", 
            "items": {
              "type": "string", 
              "enum": [
                "blockMovesIn", 
                "blockMovesOut", 
                "bytesReceived", 
                "bytesSent", 
                "configuredservice", 
                "CorePresentAlarm", 
                "cpus", 
                "davail", 
                "DiskFailureAlarm", 
                "disks", 
                "dreadK", 
                "dreads", 
                "DRILLDOWNALARM", 
                "dtotal", 
                "dused", 
                "dwriteK", 
                "dwrites", 
                "ESServerDown", 
                "faileddisks", 
                "fs-heartbeat", 
                "GatewayServiceDown", 
                "HbaseThriftServiceDown", 
                "HbProcessingSlow", 
                "health", 
                "healthDesc", 
                "HighMfsMemoryAlarm", 
                "HomeMapRFullAlarm", 
                "hostname", 
                "id", 
                "IncorrectTopologyAlarm", 
                "InstanceMismatch", 
                "Insufficient memory for buckets", 
                "ip", 
                "JobHistoryServerDown", 
                "jt-heartbeat", 
                "LogLevelAlarm", 
                "MapRfs disks", 
                "MemoryAllocationAlarm", 
                "MemorySwapping", 
                "mtotal", 
                "mused", 
                "NodeDuplicateHostIdAlarm", 
                "NodeManagerDown", 
                "NodeMaprUserMismatchAlarm", 
                "NodeMetricsWriteProblemAlarm", 
                "NodeNoHeartbeatAlarm", 
                "NodeTooManyContainersAlarm", 
                "NoDiskAttached", 
                "numInstances", 
                "numResyncSlots", 
                "numGetsInLastTenSeconds", 
                "numGetsInLastMinute", 
                "numGetsInLastFiveMinutes", 
                "numGetsInLastFifteenMinutes", 
                "numPutsInLastTenSeconds", 
                "numPutsInLastMinute", 
                "numPutsInLastFiveMinutes", 
                "numPutsInLastFifteenMinutes", 
                "numScansInLastTenSeconds", 
                "numScansInLastMinute", 
                "numScansInLastFiveMinutes", 
                "numScansInLastFifteenMinutes", 
                "PamMisconfiguredAlarm", 
                "ResourceManagerDown", 
                "RootPartitionFullAlarm", 
                "rpcin", 
                "rpcout", 
                "rpcs", 
                "service", 
                "ServiceBeeswaxDownNotRunningAlarm", 
                "ServiceCLDBDownNotRunningAlarm", 
                "ServiceFileserverDownNotRunningAlarm", 
                "ServiceHBMasterDownNotRunningAlarm", 
                "ServiceHBRegionDownNotRunningAlarm", 
                "ServiceHiveDownNotRunningAlarm", 
                "ServiceHoststatsDownNotRunningAlarm", 
                "ServiceHs2DownNotRunningAlarm", 
                "ServiceHttpfsDownNotRunningAlarm", 
                "ServiceHueDownNotRunningAlarm", 
                "ServiceJTDownNotRunningAlarm", 
                "ServiceNFSDownNotRunningAlarm", 
                "ServiceOozieDownNotRunningAlarm", 
                "ServiceTTDownNotRunningAlarm", 
                "ServicesWebserverDownNotRunningAlarm", 
                "spsPerInstance", 
                "TimeSkewAlarm", 
                "TTLocaldirFullAlarm", 
                "racktopo", 
                "ttmapSlots", 
                "ttmapUsed", 
                "ttReduceSlots", 
                "ttReduceUsed", 
                "uptime", 
                "utilization", 
                "VersionMismatchAlarm", 
                "vip"
              ]
            }, 
            "collectionFormat": "csv"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying nodes on which to start or stop services. See the Fields table on the [node](http://maprdocs.mapr.com/home/ReferenceGuide/node.html) page for the fields available to filter. See the [maprcli and REST API Syntax](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) page for information on filters.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of rows to return, beginning at start. Default: 0", 
            "type": "string"
          }, 
          {
            "name": "nfsnodes", 
            "in": "query", 
            "description": "If set to 1, displays only nodes running NFS. Cannot be used if alarmednodes is set.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Specifies whether the output should be terse or verbose.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The offset from the starting row according to sort. Default: 0", 
            "type": "string"
          }, 
          {
            "name": "zkconnect", 
            "in": "query", 
            "description": "[ZooKeeper Connect String](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-CommonParameters.html#concept_ymb_yxz_5t)", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/listcldbs": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Returns the hostnames of the nodes in the cluster that are running the CLDB service.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-listcldbs.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster for which to return the list of CLDB node hostnames.", 
            "type": "string"
          }, 
          {
            "name": "cldb", 
            "in": "query", 
            "description": "The hostname or IP address and port number of a CLDB node.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/listcldbzks": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Returns the hostnames of the nodes in the cluster that are running the CLDB service and the IP addresses and port numbers for the nodes in the cluster that are running the ZooKeeper service.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-listcldbzks.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster for which to return the CLDB and ZooKeeper information.", 
            "type": "string"
          }, 
          {
            "name": "cldb", 
            "in": "query", 
            "description": "The hostname or IP address and port number of a CLDB node.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/listzookeepers": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Returns the hostnames of the nodes in the cluster that are running the zookeeper service.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-listzookeepers.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster for which to return the list of zookeeper node hostnames.", 
            "type": "string"
          }, 
          {
            "name": "cldb", 
            "in": "query", 
            "description": "The hostname or IP address and port number of a valid CLDB node. The other CLDB nodes and zookeeper nodes can be discovered from this node.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/maintenance": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Places a node into a maintenance mode for a specified timeout duration.", 
        "description": "For the duration of the timeout, the cluster's CLDB does not consider this node's data as lost and does not trigger a resync of the data on this node. See [Managing Nodes](http://maprdocs.mapr.com/home/AdministratorGuide/c-managing-nodes.html) for more information.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-maintenance.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "serverids", 
            "in": "query", 
            "description": "List of server IDs", 
            "type": "string"
          }, 
          {
            "name": "nodes", 
            "in": "query", 
            "description": "List of nodes, space separated.", 
            "type": "string"
          }, 
          {
            "name": "timeoutminutes", 
            "in": "query", 
            "description": "Duration of timeout in minutes", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/move": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Moves one or more nodes to a different topology. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-move.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "serverids", 
            "in": "query", 
            "description": "The server IDs of the nodes to move.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "topology", 
            "in": "query", 
            "description": "The new topology.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/remove": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Removes one or more server nodes from the system. Permissions required: fc or a .", 
        "description": "After issuing the `node remove` command, wait several minutes to ensure that the node has been properly and completely removed.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-remove.html"
        }, 
        "parameters": [
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying nodes on which to start or stop services. See [Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) for more information.", 
            "type": "string"
          }, 
          {
            "name": "hostids", 
            "in": "query", 
            "description": "A list of host IDs, separated by spaces.", 
            "type": "string"
          }, 
          {
            "name": "nodes", 
            "in": "query", 
            "description": "A list of node names, separated by spaces.", 
            "type": "string"
          }, 
          {
            "name": "service", 
            "in": "query", 
            "description": "Service to be removed. Either fileserver or nfsserver.", 
            "type": "string"
          }, 
          {
            "name": "zkconnect", 
            "in": "query", 
            "description": "[ZooKeeper Connect String](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-CommonParameters.html#concept_ymb_yxz_5t). Example: 'host:port,host:port,host:port,...'. To obtain zookeeper connection strings, use the `maprcli node listzookeepers` command. Default: localhost:5181", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/services": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Starts, stops, or restarts services on one or more server nodes. Permissions required: ss , fc or a .", 
        "description": "To start or stop services, you must specify the service name, the action (start, stop, or restart), and the nodes on which to perform the action. You can specify the nodes in either of two ways:\n\n \n \n* Use the `nodes` parameter to specify a space-delimited list of node names. \n* Use the `filter` parameter to specify all nodes that match a certain pattern. See [Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html) for more information.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-services.html"
        }, 
        "parameters": [
          {
            "name": "action", 
            "in": "query", 
            "description": "An action to perform on a service specified in the `name` parameter: Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "cldb", 
            "in": "query", 
            "description": "Starts, stops, or restarts the cldb service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "fileserver", 
            "in": "query", 
            "description": "Starts, stops, or restarts the fileserver service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying nodes on which to start or stop services. For fields to use with the filter, see the Fields table in the [node list](http://maprdocs.mapr.com/home/ReferenceGuide/node-list.html) command. See [ Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html) for more information about filters.", 
            "type": "string"
          }, 
          {
            "name": "hbmaster", 
            "in": "query", 
            "description": "Starts, stops, or restarts the hbmaster service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "hbregionserver", 
            "in": "query", 
            "description": "Starts, stops, or restarts the hbregionserver service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "jobtracker", 
            "in": "query", 
            "description": "Starts, stops, or restarts the jobtracker service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "A service on which to perform an action specified by the `action` parameter. Any service can be specified with this option, but the following services can be specified only with the `name` option: `collectd`, `elasticsearch`, `fluentd`, `grafana`, `historyserver`, `hivemeta`, `hoststats`, `hs2`, `httpfs`, `hue`, `kafka-rest``kibana`, `nodemanager`, `opentsdb`, `oozie`, and `resourcemanager.`", 
            "type": "string"
          }, 
          {
            "name": "nfs", 
            "in": "query", 
            "description": "Starts, stops, or restarts the nfs service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "nodes", 
            "in": "query", 
            "description": "A list of node names, separated by spaces.", 
            "type": "string"
          }, 
          {
            "name": "tasktracker", 
            "in": "query", 
            "description": "Starts, stops, or restarts the tasktracker service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "webserver", 
            "in": "query", 
            "description": "Starts, stops, or restarts the web server service. Values: start, stop, or restart", 
            "type": "string", 
            "enum": [
              "start", 
              "stop", 
              "restart"
            ]
          }, 
          {
            "name": "zkconnect", 
            "in": "query", 
            "description": "[ZooKeeper Connect String](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-CommonParameters.html)", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/node/topo": {
      "get": {
        "tags": [
          "node"
        ], 
        "summary": "Lists cluster topology information.", 
        "description": "Lists internal nodes only (switches/racks/etc) and not leaf nodes (server nodes).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/node-topo.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "The path on which to list node topology.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/rlimit/get": {
      "get": {
        "tags": [
          "rlimit"
        ], 
        "summary": "Returns the resource usage limit for the cluster's disk resource.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/rlimit-get.html"
        }, 
        "parameters": [
          {
            "name": "resource", 
            "in": "query", 
            "description": "The type of resource to get the usage limit for. Currently only the value `disk` is supported.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster whose usage limit is being queried.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/rlimit/set": {
      "get": {
        "tags": [
          "rlimit"
        ], 
        "summary": "Sets the resource usage limit for the cluster's disk resource.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/rlimit-set.html"
        }, 
        "parameters": [
          {
            "name": "resource", 
            "in": "query", 
            "description": "The type of resource to set the usage limit for. Currently only the value `disk` is supported.", 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster whose usage limit is being set.", 
            "type": "string"
          }, 
          {
            "name": "value", 
            "in": "query", 
            "description": "The value of the limit being set. You can express the value as KB, MB, GB, or TB.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/schedule/create": {
      "get": {
        "tags": [
          "schedule"
        ], 
        "summary": "Creates a schedule. Permissions required: fc or a .", 
        "description": "A schedule can be associated with a volume to automate mirror syncing and snapshot creation. See [volume create](http://maprdocs.mapr.com/home/ReferenceGuide/volume-create.html) and [volume modify](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/schedule-create.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "schedule", 
            "in": "query", 
            "description": "A JSON object describing the schedule. See [Schedule Objects](http://maprdocs.mapr.com/home/ReferenceGuide/schedule.html) for more information.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/schedule/list": {
      "get": {
        "tags": [
          "schedule"
        ], 
        "summary": "Lists the schedules on the cluster.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/schedule-list.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Specifies whether the output should be terse or verbose.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/schedule/modify": {
      "get": {
        "tags": [
          "schedule"
        ], 
        "summary": "Modifies an existing schedule, specified by ID. Permissions required: fc or a .", 
        "description": "To find a schedule's ID:\n\n \n \n1. Use the [schedule list](http://maprdocs.mapr.com/home/ReferenceGuide/schedule-list.html) command to list the schedules. \n1. Select the schedule to modify. \n1. Pass the selected schedule's ID in the -id parameter to the `schedule modify` command.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/schedule-modify.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "id", 
            "in": "query", 
            "description": "The ID of the schedule to modify.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The new name of the schedule.", 
            "type": "string"
          }, 
          {
            "name": "rules", 
            "in": "query", 
            "description": "A JSON object describing the rules for the schedule. If specified, replaces the entire existing rules object in the schedule. For information about the fields to use in the JSON object, see [Rule Fields](http://maprdocs.mapr.com/home/ReferenceGuide/schedule.html).", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/schedule/remove": {
      "get": {
        "tags": [
          "schedule"
        ], 
        "summary": "Removes a schedule.", 
        "description": "A schedule can only be removed if it is not associated with any volumes. See [volume modify](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/schedule-remove.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "id", 
            "in": "query", 
            "description": "The ID of the schedule to remove.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/service/list": {
      "get": {
        "tags": [
          "service list"
        ], 
        "summary": "Lists all services on the specified node, the memory allocated for each service, the state of each service, and log path for each service.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/service-list.html"
        }, 
        "parameters": [
          {
            "name": "node", 
            "in": "query", 
            "description": "The node for which to list services", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/cldb": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the CLDB service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-cldb.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. The class can be at the package level or a specific class. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFO\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The CLDB port. Default: 7222", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/fileserver": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the FileServer service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-fileserver.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. The classname is listed under the `maprcli trace info` command. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFO\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The MapR-FS port. Default: 5660", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/hbmaster": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the HBase Master service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-hbmaster.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. The class can be specified at the package level or for a specific class. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFO\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The HBase Master webserver port. Default: 60000", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/hbregionserver": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the HBase RegionServer service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-hbregionserver.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. The class can be specified at the package level or for a specific class. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFo\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The Hbase Region Server webserver port. Default: 60020", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/jobtracker": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the JobTracker service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-jobtracker.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFO\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The JobTracker webserver port. Default: 9001", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/nfs": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the NFS service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-nfs.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. The classname is listed under the `maprcli trace info` command. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFO\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The NFS port. Default: 9998", 
            "type": "string"
          }, 
          {
            "name": "isusermode", 
            "in": "query", 
            "description": "Whether or not is the request is for user mode.", 
            "type": "string", 
            "enum": [
              "TRUE", 
              "FALSE"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/setloglevel/tasktracker": {
      "get": {
        "tags": [
          "setloglevel"
        ], 
        "summary": "Sets the log level on the TaskTracker service. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/setloglevel-tasktracker.html"
        }, 
        "parameters": [
          {
            "name": "classname", 
            "in": "query", 
            "description": "The name of the class for which to set the log level. Contact MapR Support for this parameter.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "loglevel", 
            "in": "query", 
            "description": "The log level to set. Default: INFO\n\n \n \n* DEBUG \n* ERROR \n* FATAL \n* INFO \n* TRACE \n* WARN", 
            "required": true, 
            "type": "string", 
            "enum": [
              "DEBUG", 
              "ERROR", 
              "FATAL", 
              "INFO", 
              "TRACE", 
              "WARN"
            ]
          }, 
          {
            "name": "node", 
            "in": "query", 
            "description": "The node on which to set the log level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "port", 
            "in": "query", 
            "description": "The TaskTracker port. Default: 50060", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/assign/list": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "For the given stream, lists consumers and the topics and partitions that the consumers are reading messages from.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm`, `consumeperm`, `produceperm`, or `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_assign_list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream.", 
            "type": "string"
          }, 
          {
            "name": "consumergroup", 
            "in": "query", 
            "description": "Specifies the ID of a particular consumer group that you want to list the consumers for.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of a topic to list the consumers for. If you also specify the `-partition` parameter, only the consumers that are reading from the indicated partition are listed.", 
            "type": "string"
          }, 
          {
            "name": "partition", 
            "in": "query", 
            "description": "The ID of a specific partition. If you specify this ID, you must also use the `-topic` parameter.", 
            "type": "string"
          }, 
          {
            "name": "detail", 
            "in": "query", 
            "description": "Includes the values of additional parameters in the output. These parameters are used internally.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/create": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Creates a new stream.", 
        "description": "After you create a stream, you can edit the values of its parameters with the command `maprcli stream edit`.\n\nTo see the value of a stream's parameters, use the command `maprcli stream info`.\n\n \n\nTo run this command, your user ID must have write permission on the directory in which you want to create a stream.\n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_create.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream to create. \n\nThe path to the stream can include any character allowed by MapR. For example, `/my/path/with:/to/mystream:topic1` is valid, but `/my/path/with:/to/mystream:withcolon:topic1 ` is invalid.\n\n \n\nThe name of the stream cannot include a colon ( : ) or a forward slash ( / ).", 
            "type": "string"
          }, 
          {
            "name": "ttl", 
            "in": "query", 
            "description": "Specifies the number of seconds to elapse between the publication of a message in a topic in this stream and the expiration of that message. \n\nConsumers do not see messages that have expired. \n\n \n\nMessages that have expired are deleted during the next purge process. See [Setting the Time-to-Live for Messages](http://maprdocs.mapr.com/home/MapR_Streams/time_to_live_for_messages.html#time_to_live_for_messages) for details. \n\n \n\nA value of 0 causes messages to be retained indefinitely.", 
            "type": "string"
          }, 
          {
            "name": "autocreate", 
            "in": "query", 
            "description": "Specifies whether to create a topic automatically when a producer tries to write the first message to it. Values are `true` and `false`. The default is `true`.", 
            "type": "boolean"
          }, 
          {
            "name": "defaultpartitions", 
            "in": "query", 
            "description": "Specifies the default number of partitions to allocate to new topics in the stream.", 
            "type": "string"
          }, 
          {
            "name": "compression", 
            "in": "query", 
            "description": "Specifies the compression setting to use for the stream. Producer client libraries can bundle messages that are to be published on the same partition and compress them. The messages are sent to the server compressed, are stored compressed, are replicated to other containers compressed, and (if stream replication is configured) replicated to replica streams compressed. Consumer client libraries receive compressed data, decompresses it, and passes it to client applications.\n\n \n\nValid options are `off`, `lzf`, `lz4`, and `zlib`. The default setting is the type of compression that is set for the directory in which the stream is located. \n\n \n\nFor more information, see [Compression](http://maprdocs.mapr.com/home/AdministratorGuide/Compression.html#Compression).", 
            "type": "string", 
            "enum": [
              "off", 
              "lz4", 
              "lzf", 
              "zlib"
            ]
          }, 
          {
            "name": "produceperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can publish messages to topics in the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "consumeperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can who can listen to topics in the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "topicperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can create, edit, or remove topics in the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "copyperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can use `mapr copystream` or `mapr diffstreams` on the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "adminperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can can modify the other access-control expressions for the stream, set up replication from the stream, and modify attributes of the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions). \n\nThis permission includes the `topicperm` permission.", 
            "type": "string"
          }, 
          {
            "name": "copymetafrom", 
            "in": "query", 
            "description": "If you plan to replicate messages to this stream from another stream, specify the path to that other stream. The metadata from that stream will be copied to the new stream when the new stream is created.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/cursor/delete": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Deletes committed cursors that are in the partitions in a stream.", 
        "description": "Note: Deleting the committed cursors for active consumers has no effect on the consumers. Consumers use read cursors to keep track of where they currently are in partitions. \n\nFor example, the consumer `consumer1` continues reading the messages in a partition from the position of the consumer's read cursor even after the consumer's committed cursor is deleted. However, if `consumer1` goes offline and the partition is reassigned to another consumer (`consumer2`) in the same consumer group before `consumer1` creates another committed cursor, `consumer2` starts reading the partition at the most recent message.\n\n \n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` or `consumeperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_cursor_delete.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream in which the committed cursors are located.", 
            "type": "string"
          }, 
          {
            "name": "consumergroup", 
            "in": "query", 
            "description": "Specifies the ID of a particular consumer group that you want to delete the committed cursors for.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of a topic to delete committed cursors from. If you also specify the `-partition` parameter, only the committed cursors in the indicated partition are deleted.", 
            "type": "string"
          }, 
          {
            "name": "partition", 
            "in": "query", 
            "description": "The ID of the partition where the committed cursors that you want to delete is located. If you specify this ID, you must also use the `-topic` parameter.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/cursor/list": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Lists the cursors for the consumers of a stream.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm`, `consumeperm`, `produceperm`, or `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_cursor_list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream in which the cursors are located.", 
            "type": "string"
          }, 
          {
            "name": "consumergroup", 
            "in": "query", 
            "description": "Specifies the ID of a particular consumer group that you want to list the cursors for.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of a topic to list committed cursors from. If you also specify the `-partition` parameter, only the committed cursors in the indicated partition are listed.", 
            "type": "string"
          }, 
          {
            "name": "partition", 
            "in": "query", 
            "description": "The ID of the partition where the particular cursor that you want to list is located. If you specify this ID, you must also use the `-topic` parameter.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/delete": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Deletes the specified stream. Deleted streams cannot be recovered unless they were previously replicated.", 
        "description": "Producers are no longer able to publish messages to topics in the stream, and consumers are no longer able to read messages from topics in the stream.\n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_delete.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream to delete.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/edit": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Edits the values of parameters for the specified stream.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_edit.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream to create.", 
            "type": "string"
          }, 
          {
            "name": "ttl", 
            "in": "query", 
            "description": "Specifies the number of seconds to elapse between the publication of a message in a topic in this stream and the expiration of that message. \n\nConsumers do not see messages that have expired. \n\n \n\nMessages that have expired are deleted during the next purge process. See [Setting the Time-to-Live for Messages](http://maprdocs.mapr.com/home/MapR_Streams/time_to_live_for_messages.html#time_to_live_for_messages) for details. \n\n \n\nA value of 0 causes messages to be retained indefinitely.", 
            "type": "string"
          }, 
          {
            "name": "autocreate", 
            "in": "query", 
            "description": "Specifies whether to create a topic automatically when a producer tries to write the first message to it. Values are `true` and `false`. The default is `true`.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "defaultpartitions", 
            "in": "query", 
            "description": "Specifies the default number of partitions to allocate to new topics in the stream.", 
            "type": "string"
          }, 
          {
            "name": "compression", 
            "in": "query", 
            "description": "Specifies the compression setting to use for the stream. Producer client libraries can bundle messages that are to be published on the same partition and compress them. The messages are sent to the server compressed, are stored compressed, are replicated to other containers compressed, and (if stream replication is configured) replicated to replica streams compressed. Consumer client libraries receive compressed data, decompresses it, and passes it to client applications.\n\n \n\nValid options are `off`, `lzf`, `lz4`, and `zlib`. The default setting is the type of compression that is set for the directory in which the stream is located. \n\n \n\nFor more information, see [Compression](http://maprdocs.mapr.com/home/AdministratorGuide/Compression.html#Compression).", 
            "type": "string", 
            "enum": [
              "off", 
              "lz4", 
              "lzf", 
              "zlib"
            ]
          }, 
          {
            "name": "produceperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can publish messages to topics in the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "consumeperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can who can listen to topics in the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "topicperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can create, edit, or remove topics in the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "copyperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can use `mapr copystream` or `mapr diffstreams` on the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions).", 
            "type": "string"
          }, 
          {
            "name": "adminperm", 
            "in": "query", 
            "description": "Specifies the access-control expression that controls who can can modify the other access-control expressions for the stream, set up replication from the stream, and modify attributes of the stream. See [ACE Syntax](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions). \n\nThis permission includes the `topicperm` permission.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/info": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Displays the values of the parameters of the specified stream.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n*   **`adminperm`**<br/> When a user with this permission runs the command, the output includes the access-control expressions for the `adminperm` and `topicperm` permissions.<br/> **`produceperm`, `consumeperm`, or `topicperm`**<br/> When a user with one of these permissions runs the command, the output does not include any access-control expressions.<br/>   \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_info.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to see information about.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/purge": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Runs the purge process, removing messages that are marked for deletion and reclaiming disk space.", 
        "description": "For information about the purge process, see [Setting the Time-to-Live for Messages](http://maprdocs.mapr.com/home/MapR_Streams/time_to_live_for_messages.html#time_to_live_for_messages__title).\n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.\n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_purge.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream to reclaim disk space from.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/add": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Registers an existing stream as a replica of the specified stream.", 
        "description": "## Permissions Required at the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` and `copyperm` permissions on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.\n\n \n\n \n\n\n\n## Permissions Required at the Target Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_add.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to create a replica for.", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path and name of the stream that you want to create as a replica of the stream that you specified with the `-path` parameter.", 
            "type": "string"
          }, 
          {
            "name": "paused", 
            "in": "query", 
            "description": "A boolean value that specifies whether to pause the replication so that it does not start immediately. The replication can be resumed using the replica resume command at a later time. The values are `true` or `false`. The default is `false`.\n\nSet `-paused` to `true` if you want to run `mapr copystream` to load the replica stream before starting replication. If it is not paused, replication starts immediately after you run the commands `maprcli stream replica add` and `maprcli stream upstream add`, in which case the replica stream starts empty and accumulates messages over time. If you are interested only in the messages that are published to the source stream after replication starts, then you do not need to pause replication initially. However, if you want the full set of messages from the source stream that have not yet been purged or marked for deletion, then pause replication initially.", 
            "type": "boolean"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are `true` or `false`. The default is `false`.\n\nThrottling has two effects, both of which allow MapR Streams to use more system resources to process new messages:\n \n* Throttling slows down the rate at which changes to a stream are replicated. \n* Throttling slows down the rate at which messages to be replicated are read from disk.", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. The default is `false`. If you set the value to `true`, the local cluster and any other cluster that is part of the replication process must be enabled for security.", 
            "type": "boolean"
          }, 
          {
            "name": "synchronous", 
            "in": "query", 
            "description": "A boolean value that specifies whether replication is synchronous or asynchronous. The values are `true` or `false`. The default is `false` and specifies asynchronous replication.", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "Specifies the type of compression to use when replicating messages. For more information, see [Compression](http://maprdocs.mapr.com/home/AdministratorGuide/Compression.html#Compression).", 
            "type": "string", 
            "enum": [
              "off", 
              "lz4", 
              "lzf", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/autosetup": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Sets up and starts replication between a source stream and replica stream.", 
        "description": "The `maprcli stream replica autosetup` command performs the following steps to set up replication:\n \n1. Creates a stream in the destination cluster. \n1. Declares the new stream to be a replica of the source stream and ensures that replication does not begin immediately after the next step. \n1. Declares the source stream as the original of the replica stream. \n1. Runs the `mapr copystream` utility to load a copy of the source data into the replica. \n1. Clears the paused replication state to start replication. \n\n \n\n \n\n \n\n\n\n## Permissions Required at the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` and `copyperm` permissions on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.\n\n \n\n \n\n\n\n## Permissions Required at the Target Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_autosetup.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to create a replica for.", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path and name of the stream that you want to create as a replica of the stream that you specified with the `-path` parameter.", 
            "type": "string"
          }, 
          {
            "name": "synchronous", 
            "in": "query", 
            "description": "A boolean value that specifies whether replication is synchronous or asynchronous. The values are `true` or `false`. The default is `false` and specifies asynchronous replication.", 
            "type": "boolean"
          }, 
          {
            "name": "multimaster", 
            "in": "query", 
            "description": "A boolean value that specifies whether or not to set up a multi-master topology. The values are `true` or `false`. The default is `false` and specifies to use the basic master-slave topology, rather than the multi-master topology.", 
            "type": "boolean"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are `true` or `false`. The default is `false`.\n\nThrottling has two effects, both of which allow MapR Streams to use more system resources to process new messages:\n \n* Throttling slows down the rate at which changes to a stream are replicated. \n* Throttling slows down the rate at which messages to be replicated are read from disk.", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. The default is `false`. If you set the value to `true`, the local cluster and any other cluster that is part of the replication process must be enabled for security.", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "Specifies the type of compression to use when replicating messages. For more information, see [Compression](http://maprdocs.mapr.com/home/AdministratorGuide/Compression.html#Compression).", 
            "type": "string", 
            "enum": [
              "off", 
              "lz4", 
              "lzf", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/edit": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Modifies the way in which messages are replicated from one stream to another.", 
        "description": "## Permissions Required at the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.\n\n \n\n \n\n\n\n## Permissions Required at the Target Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_edit.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to create a replica for.", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path and name of the stream that you want to create as a replica of the stream that you specified with the `-path` parameter.", 
            "type": "string"
          }, 
          {
            "name": "newreplica", 
            "in": "query", 
            "description": "Specifies a new name to give to the replica stream.", 
            "type": "string"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are `true` or `false`. The default is `false`.\n\nThrottling has two effects, both of which allow MapR Streams to use more system resources to process new messages:\n \n* Throttling slows down the rate at which changes to a stream are replicated. \n* Throttling slows down the rate at which messages to be replicated are read from disk.", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. The default is `false`. If you set the value to `true`, the local cluster and any other cluster that is part of the replication process must be enabled for security.", 
            "type": "boolean"
          }, 
          {
            "name": "synchronous", 
            "in": "query", 
            "description": "A boolean value that specifies whether replication is synchronous or asynchronous. The values are `true` or `false`. The default is `false` and specifies asynchronous replication.", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "Specifies the type of compression to use when replicating messages. For more information, see [Compression](http://maprdocs.mapr.com/home/AdministratorGuide/Compression.html#Compression).", 
            "type": "string", 
            "enum": [
              "off", 
              "lz4", 
              "lzf", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/list": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Lists the replicas of a given stream.", 
        "description": "## Permissions Required on the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to list the replicas of.", 
            "type": "string"
          }, 
          {
            "name": "refreshnow", 
            "in": "query", 
            "description": "A boolean value that specifies whether to trigger an immediate update of the replica statistics. The values are `true` or `false`. By default, the value is `false` and the command lists the current version of the replica statistics, which could be a maximum of five minutes old.", 
            "type": "boolean"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/pause": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Pauses replication from a source stream to a replica stream.", 
        "description": "## Permissions Required on the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_pause.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that is the source for the replica that you want to pause replication to.", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path and name of the stream replica that you want to pause replication to.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/remove": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Unregisters a stream as the replica of another stream.", 
        "description": "## Permissions Required on the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_remove.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that is the source for the replica that you want to remove.", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path and name of the stream replica that you want to remove.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/replica/resume": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Resumes replication from one stream to another stream.", 
        "description": "## Permissions Required on the Source Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_replica_resume.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that is the source for the replica that you want to resume replicating to.", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path and name of the stream replica that you want to resume replicating to.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/upstream/add": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Registers a stream as an upstream source for a given stream. For example, if you wanted to replicate messages from Stream_A to Stream_B , Stream_A would be the upstream source for Stream_B .", 
        "description": "## Permissions Required on the Target Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_upstream_add.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to specify a source stream for.", 
            "type": "string"
          }, 
          {
            "name": "upstream", 
            "in": "query", 
            "description": "The path and name of the stream that you want to use as a source for the stream that you specified with the `-path` parameter.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/upstream/list": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Lists all of the streams that are replicating to a given stream.", 
        "description": "## Permissions Required on the Target Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_upstream_list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to list the source streams for.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/upstream/remove": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Unregisters a stream as an upstream source for a given stream.", 
        "description": "## Permissions Required on the Target Cluster\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm` permission on the source stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_upstream_remove.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream that you want to remove a source stream from.", 
            "type": "string"
          }, 
          {
            "name": "upstream", 
            "in": "query", 
            "description": "The path and name of the stream that you want to remove as a source for the stream that you specified with the `-path` parameter.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/topic/create": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Creates a topic in the specified stream.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_topic_create.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream in which to create the topic.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of the topic to create.\n\nA name can include alphanumeric characters and the following characters: `.` , `_` , and `-` .", 
            "type": "string"
          }, 
          {
            "name": "partitions", 
            "in": "query", 
            "description": "The number of partitions to use for the topic. After you create the topic, you can increase the number of partitions, but you cannot reduce the number. The default number of partitions for new topics is set by the defaultpartitions parameter in the commands maprcli stream create and maprcli stream edit.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/topic/delete": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Deletes the specified topic from the specified stream.", 
        "description": "Consumers do not have to stop consuming from a topic before the topic is deleted.\n\nThe deletion of the topic and the messages is immediate. However, the command also starts a background process for the purging the topic and messages to reclaim disk space. \n\n \n\nIf the parameter `-autocreate` for the stream is set to `true`, a topic with the same name is created if a producer writes a message to a topic of the same name. For example, if you delete the topic `Topic_A` and then a producer writes a message to the topic `Topic_A`, MapR Streams creates a topic that is named `Topic_A`. Aside from the name, the new topic `Topic_A` shares nothing with the deleted topic `Topic_A`.\n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_topic_delete.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream from which to delete the topic.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of the topic to delete.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/topic/edit": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Allows you to increase the number of partitions that are in the specified topic.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_topic_edit.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream in which the topic is located.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of the topic to edit.", 
            "type": "string"
          }, 
          {
            "name": "partitions", 
            "in": "query", 
            "description": "The number of partitions to use for the topic. You cannot reduce the number of partitions.\n\nTo find out how many partitions a topic is currently using, run the command `maprcli stream topic info.`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/topic/info": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Lists information about the partitions in the topics that are in a stream.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm`, `consumeperm`, `produceperm`, or `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_topic_info.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream for which you want to display information about topics.", 
            "type": "string"
          }, 
          {
            "name": "topic", 
            "in": "query", 
            "description": "The name of the topic for which you want to display information.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/stream/topic/list": {
      "get": {
        "tags": [
          "stream"
        ], 
        "summary": "Lists the topics that are in a stream, as well as the number of partitions in each topic.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminperm`, `consumeperm`, `produceperm`, or `topicperm` permission on the stream \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR Streams does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/stream_topic_list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path and name of the stream for which you want to list the topics.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/create": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Creates a new MapR-DB binary or JSON table.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-create.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the new MapR-DB table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at /volume1, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "copymetafrom", 
            "in": "query", 
            "description": "The path to a table that contains the metadata that should be used to create the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, if you want to copymetadata from a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test` ``  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, if you want to copymetadata from a table named test under volume1 in the sanfrancisco cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "copymetatype", 
            "in": "query", 
            "description": "The type of metadata to copy from the table identified in the `copymetafrom` parameter. You can specify one or more of the following options in a comma separated list:\n\n \n \n*  `all`. Copy all metadata. This is the default. \n*  `cfs`. Copy column family metadata. \n*  `aces`. Copy ACE permissions. \n*  `splits`. Copy split keys. \n*  `attrs`. Copy table attributes.", 
            "type": "string", 
            "enum": [
              "all", 
              "cfs", 
              "aces", 
              "splits", 
              "attrs"
            ]
          }, 
          {
            "name": "regionsizemb", 
            "in": "query", 
            "description": "The average size of the regions into which MapR-DB tries to split the table as the table grows. The default is 4096 MB. This value is ignored if `autosplit` is set to `false`.\n\n \n\nIf `autosplit` is set to `true`, MapR-DB splits a region when the size of the region exceeds 150% of the average value. For example, if the average value is 4096 MB, MapR-DB splits a region that is larger than 6144 MB.\n\n \n\nAlthough splits are automatic, merges are not. For example, if the value of `regionsizemb` is changed from 8 GB to 4 GB, all regions that are eligible are split automatically, if `autosplit` is set to `true`. However, if the value of `regionsizemb` is changed from 2 GB to 4 GB, regions smaller than 4 GB are not automatically merged.\n\n \n\nNote: When a table has less than 4 regions, MapR-DB ignores the `regionsizemb` parameter and splits regions at a lower threshold.", 
            "type": "string"
          }, 
          {
            "name": "autosplit", 
            "in": "query", 
            "description": "A Boolean value that specifies whether to split the table into regions automatically as the table grows. The average size of each region is determined by the `regionsizemb` parameter.\n\n \n\nThe default value is `true`. If you set the value to `false`, you can manually split tables into regions by using the `table region split` command.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "bulkload", 
            "in": "query", 
            "description": "A Boolean value that specifies whether to allow a full bulk load of the table. The default is `false`. For more information, see [Loading Data into Binary Tables](http://maprdocs.mapr.com/home/MapR-DB/BulkLoadingandMapR-DBTables-binary.html) and [Loading Documents into JSON Tables](http://maprdocs.mapr.com/home/MapR-DB/JSON_DB/loading_documents_into_json_tables.html).", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "audit", 
            "in": "query", 
            "description": "Specifies whether to turn auditing on for the table. If auditing is also enabled at the cluster level with the `maprcli audit data` command and enabled for the current volume, setting this value to true causes auditing to start for the table.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "tabletype", 
            "in": "query", 
            "description": "Specifies whether the table will be a binary table or a JSON table. The values are `binary` and `json`. The default is `binary`.", 
            "type": "string", 
            "enum": [
              "binary", 
              "json"
            ]
          }, 
          {
            "name": "insertionorder", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** Specifies whether query results are to list fields in the order in which fields were inserted into column families. Column families are always returned in alphabetical order according to their names. \n\n \n\nFor example, suppose you had a JSON table that contained documents with this general structure: \n\n```\n{\n     \"_id\":\"value\",\n     \"title\" : \"Name of movie\",\n     \"trailers\" :\n          {\n               \"theatrical\" : \"Link to .mp4 file\",\n               \"teaser\" : \"Link to .mp4 file\"\n          }\n     \"images\":\n          {\n               \"small\" : \"Link to .jpg file\",\n               \"large\" : \"Link to .jpg file\"\n          }\n}\n```\n\nBoth trailers and images are separate column families named, say, `cf1` and `cf2` respectively (while title belongs to default column family). \n\n \n\nAn application retrieves the full document for each movie. If `-insertionorder` is set to `true`, the results are returned in this order: \n\n```\n{\n     \"trailers\" :\n          {\n               \"theatrical\" : \"Link to .mp4 file\",\n               \"teaser\" : \"Link to .mp4 file\"\n          }\n     \"images\" :\n          {\n               \"small\" : \"Link to .jpg file\",\n               \"large\" : \"Link to .jpg file\"\n          },\n     \"title\" : \"Name of movie\",\n}\n```\n\nThe results are identical to the original document, except that the fields are arranged by column family names (`cf1`, `cf2`, and default) in alphabetical order, as they always are for a query. \n\n \n\nIf `-insertionorder` is set to `false`, the results are returned in this order: \n\n```\n{\n     \"images\" :\n          {\n               \"large\" : \"Link to .jpg file\",\n               \"small\" : \"Link to .jpg file\"\n          },\n     \"title\" : \"Name of movie\",\n     \"trailers\" :\n          {\n               \"teaser\" : \"Link to .mp4 file\",\n               \"theatrical\" : \"Link to .mp4 file\"\n          }\n}\n```\n\nThe results are similar to the previous results. This time, however, all the fields are in alphabetical order.", 
            "type": "boolean"
          }, 
          {
            "name": "packperm", 
            "in": "query", 
            "description": "The Access Control Expression that controls who can pack table regions. By default, permission is given to the user ID that is used to create the table.", 
            "type": "string"
          }, 
          {
            "name": "bulkloadperm", 
            "in": "query", 
            "description": "The Access Control Expression that controls who can load this table with bulk loads if the table was created with bulk load support. By default, permission is given to the user ID that is used to create the table.", 
            "type": "string"
          }, 
          {
            "name": "splitmergeperm", 
            "in": "query", 
            "description": "The Access Control Expression that controls who can take the following actions:\n\n \n \n* Run the `table region split` and `table region merge` commands to split the table into regions or to merge regions of the table together.  \n* Change the value of `regionsizemb`. \n\n \n\nBy default, permission is given to the user ID that is used to create the table.", 
            "type": "string"
          }, 
          {
            "name": "createrenamefamilyperm", 
            "in": "query", 
            "description": "The Access Control Expression that controls who can create column families for this table or rename existing column families. By default, permission is given to the user ID that is used to create the table.", 
            "type": "string"
          }, 
          {
            "name": "deletefamilyperm", 
            "in": "query", 
            "description": "The Access Control Expression that defines access to delete column families for this table. Delimit the expression with single-quotation marks. By default, permission is given to the user ID that is used to create the table.", 
            "type": "string"
          }, 
          {
            "name": "adminaccessperm", 
            "in": "query", 
            "description": "The Access Control Expression that controls who can view and edit the permissions for this table. By default, permission is given to the user ID that is used to create the table.", 
            "type": "string"
          }, 
          {
            "name": "replperm", 
            "in": "query", 
            "description": "The Access Control Expression that controls who can set up replication either to or from a table. By default, permission is given to the user ID that is used to create the table", 
            "type": "string"
          }, 
          {
            "name": "defaultversionperm", 
            "in": "query", 
            "description": "The default Access Control Expression for the version permission on new column families that are created in this table. If no value is specified, the default is `u:<username of the table creator>`. This value of the parameter `versionperm` in the `table cf create` and `table cf edit` commands overrides this value.\n\nNote: This permission is not applicable to JSON tables. Versioning is not supported for JSON documents.", 
            "type": "string"
          }, 
          {
            "name": "defaultcompressionperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The default Access Control Expression for the compression permission on new column families that are created in this table. If no value is specified, the default is `u:<username of the table creator>`. This value of the parameter `compressionperm` in the `table cf create` and `table cf edit` commands overrides this value.", 
            "type": "string"
          }, 
          {
            "name": "defaultmemoryperm", 
            "in": "query", 
            "description": "The default Access Control Expression for the memory permission on new column families that are created in this table. If no value is specified, the default is `u:<username of the table creator>`. This value of the parameter `memoryperm` in the `table cf create` and `table cf edit` commands overrides this value.", 
            "type": "string"
          }, 
          {
            "name": "defaultreadperm", 
            "in": "query", 
            "description": "The default Access Control Expression for the read permission on new column families that are created in this table. If no value is specified, the default is `u:<username of the table creator>`. This value of the parameter `readperm` in the `table cf create` and `table cf edit` commands overrides this value.\n\nFor more information about this permission as it applies to JSON tables, see [Permission Types for JSON Tables](http://maprdocs.mapr.com/home/MapR-DB/JSON_DB/granting_or_denying_access_to_fields_with_aces.html#granting_or_denying_access_to_fields_with_aces).", 
            "type": "string"
          }, 
          {
            "name": "defaultwriteperm", 
            "in": "query", 
            "description": "The default Access Control Expression for the write permission on new column families that are created in this table. If no value is specified, the default is `u:<username of the table creator>`. This value of the parameter `writeperm` in the `table cf create` and `table cf edit` commands overrides this value.\n\nFor more information about this permission as it applies to JSON tables, see [Permission Types for JSON Tables](http://maprdocs.mapr.com/home/MapR-DB/JSON_DB/granting_or_denying_access_to_fields_with_aces.html#granting_or_denying_access_to_fields_with_aces).", 
            "type": "string"
          }, 
          {
            "name": "defaulttraverseperm", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** The default Access Control Expression for the traverse permission on new column families. For more information about this permission, see [Permission Types for JSON Tables](http://maprdocs.mapr.com/home/MapR-DB/JSON_DB/granting_or_denying_access_to_fields_with_aces.html#granting_or_denying_access_to_fields_with_aces).", 
            "type": "string"
          }, 
          {
            "name": "defaultappendperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The default Access Control Expression for the append permission on new column families that are created in this table. If no value is specified, the default is `u:<username of the table creator>`. This value of the parameter `appendperm` in the `table cf create` and `table cf edit` commands overrides this value.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/colperm/get": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Lists the Access Control Expressions (ACEs) for a specified column.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-colperm-get.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family in which the column is located.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the column that you want to list the ACEs for. If you do not specify the column name, the ACEs for all of the columns in the family are listed.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/colperm/set": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Sets Access Control Expressions (ACEs) for a specified column.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-colperm-set.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family in which the column is located.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "**For binary tables: **The name of the column for which you want to set the ACEs.\n\n**For JSON tables: **The fieldpath of the field on which you want to set permissions. For example, if you wanted to grant `readperm` to a user on field `b` in the following document. the fieldpath would be `a.b`.\n\n```\n{\n  \"a\" : {\n          \"b\" : \"value_b\"\n        }\n}\n```", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "appendperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for column appends. Use single quotation marks around the ACE. \n\n \n\nColumn appends require permission both at the column-family level and at the column level.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "readperm", 
            "in": "query", 
            "description": "The Access Control Expression for column reads. Use single quotation marks around the ACE. \n\n \n\nReads require permission both at the column-family level and at the column level (for binary tables) or field level (for JSON tables). In JSON tables, this permission is inherited by fields within the column family.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "writeperm", 
            "in": "query", 
            "description": "The Access Control Expression for column writes (puts and deletes). Use single quotation marks around the ACE. \n\n \n\nWrites require permission both at the column-family level and at the column level (for binary tables) or field level (for JSON tables). In JSON tables, this permission is inherited by fields within the column family.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "traverseperm", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** The Access Control Expressions that specifies who has permission to pass over fields in JSON documents. For example, suppose that a JSON table contains documents of this general structure: \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \"value\",\n               \"c\" : \"value\"\n          }\n}\n```\n\nSuppose further that the user `sjohnson` has read permission on` a.b`, but not on `a`. For `sjohnson` to read `a.b`, the user needs the traverse permission on `a`. The user can then pass over field `a` to `a.b`. \n\n \n\nThis permission is inherited by fields within the column family. By default, this permission is given to the value of defaulttraverseperm for the JSON table.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/colperm/delete": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Deletes the Access Control Expressions (ACEs) for a specified column. Deletion cannot be undone.", 
        "description": "Note: When a user, group, or role requests to read data from, write data to, or append data to a column, MapR-DB checks whether that user, group, or role has read or write permission for the column family AND read or write permission for the column. For example, suppose user `i_montoya` tries to write data to columns `col1` and `col2` in column family `cf1`. MapR-DB checks whether `i_montoya` has write permission on `cf1` AND `col1` AND `col2`. If `i_montoya` does not have all three permissions, MapR-DB returns an error that says access for the write is denied.\n\nIf this user were to try to read from the same two columns, MapR-DB would simply not return the data. If the user tried to read from those two columns and additional columns on which he had read permissions, the results would contain the data for those additional columns but exclude the data for `col1` and `col2`.\n\n \n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-colperm-delete.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family in which the column is located.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the column that you want to delete the ACEs for.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/create": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Creates a column family for a MapR binary or JSON table.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `createrenamefamilyperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-create.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family to create.", 
            "type": "string"
          }, 
          {
            "name": "minversions", 
            "in": "query", 
            "description": "**Applies to binary tables only: **Minimum number of versions of column values to keep. The default is zero.", 
            "type": "string"
          }, 
          {
            "name": "maxversions", 
            "in": "query", 
            "description": "**Applies to binary tables only: **Maximum number of versions of column values to keep. The default is one.", 
            "type": "string"
          }, 
          {
            "name": "ttl", 
            "in": "query", 
            "description": "Time to live in seconds. When the age of the data in this column family exceeds the value of the `ttl` parameter, the data is purged. Setting the value of `ttl` to 0 is equivalent to allowing data to remain indefinitely. Default: 0\n\nNote: If the value of `-ttl` for an existing column family in a JSON table is not 0, you cannot add another column family. See [Setting TTL for Data](http://maprdocs.mapr.com/home/MapR-DB/JSON_DB/setting_the_time_to_live.html#setting_the_time_to_live).", 
            "type": "string"
          }, 
          {
            "name": "inmemory", 
            "in": "query", 
            "description": "Boolean. Determines whether preference is given to values of this column family for storage with row keys. Because row keys are cached in memory in preference to row data, column-family data that is stored inline with the row keys is also cached in memory.\n\n \n\nFor all column families in a table together, up to 200 bytes of row data will be stored inline with each row key. Storing data inline with a row key might speed retrieval of the data from a column family because disk access can often be avoided. For each column family, up to 32 bytes can be stored inline with each row key even if its `inmemory` parameter is set to `false`, but preference will be given to column families where this parameter is set to `true`. A column family can have more than 32 bytes stored inline if its `inmemory` parameter is set to `true`.\n\n \n\nIf the total number of bytes for all column families together exceeds 200 for a row, then preference for inclusion within the inline storage for that row is given to column families that have the `inmemory` parameter set to `true`.\n\n \n\nNote: All of the data for a column family will be stored in-line with the row key, or none will be. If the contents in a column family for a particular row are larger than the maximum number of bytes that are allowed to be stored for that column family, no data at all will be stored in-line for that column family.\n\n \n\nThe default value for the `inmemory` parameter is `false`.", 
            "type": "boolean"
          }, 
          {
            "name": "compression", 
            "in": "query", 
            "description": "The compression setting to use for the column family. Valid options are `off`, `lzf`, `lz4`, and `zlib`. The default setting is equal to the compression setting for the directory in which the table is located. To find out whether a directory is compressed and the type of compression, see [Turning Compression On or Off on Directories](http://maprdocs.mapr.com/home/AdministratorGuide/TurningCompressionOnOff.html).", 
            "type": "string", 
            "enum": [
              "off", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }, 
          {
            "name": "versionperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for changing the value of the `maxversions` and `minversions` parameters. By default, permission is given to the value of `defaultversionperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "compressionperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for changing the value of the `compression` parameter. By default, permission is given to the value of `defaultcompressionperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "memoryperm", 
            "in": "query", 
            "description": "The Access Control Expression for changing the value of the `inmemory` parameter. Use single quotation marks around the ACE. By default, permission is given to the value of `defaultmemoryperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "readperm", 
            "in": "query", 
            "description": "The Access Control Expression for column reads. Use single quotation marks around the ACE. \n\n \n\nReads require permission both at the column-family level and at the column level (for binary tables) or field level (for JSON tables). In JSON tables, this permission is inherited by fields within the column family.\n\n \n\nBy default, permission is given to the value of `defaultreadperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "writeperm", 
            "in": "query", 
            "description": "The Access Control Expression for column writes (puts and deletes). Use single quotation marks around the ACE. \n\n \n\nWrites require permission both at the column-family level and at the column level (for binary tables) or field level (for JSON tables). In JSON tables, this permission is inherited by fields within the column family. \n\n \n\nBy default, permission is given to the value of `defaultwriteperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "appendperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for column appends. Use single quotation marks around the ACE. \n\n \n\nColumn appends require permission both at the column-family level and at the column level. By default, permission is given to the value of `defaultappendperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "jsonpath", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** Specifies the path to the column family. The path is in dotted notation. For example, suppose the table contained JSON documents that were of this general structure: \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \n                    {\n                         \"c\" : \"value\",\n                    },\n               \"e\" : \"value\"\n          }\n}\n```\n\nYou want to create a column family at the field `d `in the new path `a.b.d` because you plan to store image files in fields in that column family. \n\nImportant: Ensure that the field at which you want to create the column family does not yet exist. If the field does exist, it could become inaccessible after the column family is created.", 
            "type": "string"
          }, 
          {
            "name": "force", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** By default, every time you try to create a non-default column family in a JSON table, this command fails and returns a warning message that you should ensure there is no existing data at the specified path. Set this parameter to true if you want to override this warning mechanism and create a column family.", 
            "type": "boolean"
          }, 
          {
            "name": "traverseperm", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** The Access Control Expressions that specifies who has permission to pass over fields in JSON documents. For example, suppose that a JSON table contains documents of this general structure: \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \"value\",\n               \"c\" : \"value\"\n          }\n}\n```\n\nSuppose further that the user `sjohnson` has read permission on` a.b`, but not on `a`. For `sjohnson` to read `a.b`, the user needs the traverse permission on `a`. The user can then pass over field `a` to `a.b`. \n\n \n\nThis permission is inherited by fields within the column family. By default, this permission is given to the value of defaulttraverseperm for the JSON table.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/delete": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Deletes a column family from a MapR-DB binary table or JSON table . Deletion cannot be undone.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `deletefamilyperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-delete.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family to delete.\n\n \n\nNote: In JSON tables, it is not possible to delete the default column family.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/edit": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Edits a column family in a binary table or JSON table .", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `createrenamefamilyperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-edit.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family to edit.", 
            "type": "string"
          }, 
          {
            "name": "newcfname", 
            "in": "query", 
            "description": "The new name to give to the column family.", 
            "type": "string"
          }, 
          {
            "name": "minversions", 
            "in": "query", 
            "description": "**Applies to binary tables only: **Minimum number of versions of column values to keep. The default is zero.", 
            "type": "string"
          }, 
          {
            "name": "maxversions", 
            "in": "query", 
            "description": "**Applies to binary tables only: **Maximum number of versions of column values to keep. The default is one.", 
            "type": "string"
          }, 
          {
            "name": "ttl", 
            "in": "query", 
            "description": "Time to live in seconds. When the age of the data in this column family exceeds the value of the `ttl` parameter, the data is purged. Setting the value of `ttl` to 0 is equivalent to allowing data to remain indefinitely. Default: 0\n\nNote: If the value of `-ttl` for an existing column family in a JSON table is not 0, you cannot add another column family. See [Setting TTL for Data](http://maprdocs.mapr.com/home/MapR-DB/JSON_DB/setting_the_time_to_live.html#setting_the_time_to_live).", 
            "type": "string"
          }, 
          {
            "name": "inmemory", 
            "in": "query", 
            "description": "Boolean. Determines whether preference is given to values of this column family for storage with row keys. Because row keys are cached in memory in preference to row data, column-family data that is stored inline with the row keys is also cached in memory.\n\n \n\nFor all column families in a table together, up to 200 bytes of row data will be stored inline with each row key. Storing data inline with a row key might speed retrieval of the data from a column family because disk access can often be avoided. For each column family, up to 32 bytes can be stored inline with each row key even if its `inmemory` parameter is set to `false`, but preference will be given to column families where this parameter is set to `true`. A column family can have more than 32 bytes stored inline if its `inmemory` parameter is set to `true`.\n\n \n\nIf the total number of bytes for all column families together exceeds 200 for a row, then preference for inclusion within the inline storage for that row is given to column families that have the `inmemory` parameter set to `true`.\n\n \n\nNote: All of the data for a column family will be stored in-line with the row key, or none will be. If the contents in a column family for a particular row are larger than the maximum number of bytes that are allowed to be stored for that column family, no data at all will be stored in-line for that column family.\n\n \n\nThe default value for the `inmemory` parameter is `false`.", 
            "type": "string"
          }, 
          {
            "name": "compression", 
            "in": "query", 
            "description": "The compression setting to use for the column family. Valid options are `off`, `lzf`, `lz4`, and `zlib`. The default setting is equal to the compression setting for the directory in which the table is located. To find out whether a directory is compressed and the type of compression, see [Turning Compression On or Off on Directories](http://maprdocs.mapr.com/home/AdministratorGuide/TurningCompressionOnOff.html#concept_cxv_4k3_f5).", 
            "type": "string", 
            "enum": [
              "off", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }, 
          {
            "name": "versionperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for changing the value of the `maxversions` and `minversions` parameters. By default, permission is given to the value of `defaultversionperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "compressionperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for changing the value of the `compression` parameter. By default, permission is given to the value of `defaultcompressionperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "memoryperm", 
            "in": "query", 
            "description": "The Access Control Expression for changing the value of the `inmemory` parameter. Use single quotation marks around the ACE. By default, permission is given to the value of `defaultmemoryperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "readperm", 
            "in": "query", 
            "description": "The Access Control Expression for column reads. Use single quotation marks around the ACE. \n\n \n\nReads require permission both at the column-family level and at the column level (for binary tables) or field level (for JSON tables). In JSON tables, this permission is inherited by fields within the column family.\n\n \n\nBy default, permission is given to the value of `defaultreadperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "writeperm", 
            "in": "query", 
            "description": "The Access Control Expression for column writes (puts and deletes). Use single quotation marks around the ACE. \n\n \n\nWrites require permission both at the column-family level and at the column level (for binary tables) or field level (for JSON tables). In JSON tables, this permission is inherited by fields within the column family. \n\n \n\nBy default, permission is given to the value of `defaultwriteperm` for the table.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "appendperm", 
            "in": "query", 
            "description": "**Applies to binary tables only: **The Access Control Expression for column appends. Use single quotation marks around the ACE. \n\n \n\nColumn appends require permission both at the column-family level and at the column level. By default, permission is given to the value of `defaultappendperm` for the table.", 
            "type": "string"
          }, 
          {
            "name": "traverseperm", 
            "in": "query", 
            "description": "**Applies to JSON tables only:** The Access Control Expressions that specifies who has permission to pass over fields in JSON documents. For example, suppose that a JSON table contains documents of this general structure: \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \"value\",\n               \"c\" : \"value\"\n          }\n}\n```\n\nSuppose further that the user `sjohnson` has read permission on` a.b`, but not on `a`. For `sjohnson` to read `a.b`, the user needs the traverse permission on `a`. The user can then pass over field `a` to `a.b`. \n\n \n\nThis permission is inherited by fields within the column family. By default, this permission is given to the value of defaulttraverseperm for the JSON table.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/cf/list": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Lists a MapR table's column families.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-cf-list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named test under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "cfname", 
            "in": "query", 
            "description": "The name of the column family to edit.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/delete": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Deletes a MapR-DB binary or JSON table .", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-delete.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "Path to the MapR table to delete.\n \n* For a path on the local cluster, start the path at the volume mount point. For example, if you want to delete a table named `test` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, if you want to delete a table named `customer` under volume1 in the sanfrancisco cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/edit": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Edits the attributes of a MapR-DB binary or JSON table .", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-edit.html"
        }, 
        "parameters": [], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/info": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Displays information about a MapR-DB binary or JSON table .", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `adminaccessperm` on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-info.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/region/list": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Lists the regions that make up a specified table.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-region-list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "Path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, if you want to list regions for a table named `test` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, if you want to list regions for a table named `test` under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The offset from the starting region. The default value is 0.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of regions to return, counting from the starting region. The default value is 2147483647.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/region/merge": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Merges regions of a table together to reduce the number of regions that a table occupies.", 
        "description": "This command merges the region that you specify with the region that contains the row keys that immediately follow the row keys of the specified region.\n\n \n\nNote: Consider the table configuration when you decide to merge regions because it is possible that MapR-DB might immediately split the regions after they are merged. If `autosplit` is set to true, MapR-DB splits a region when the size of the region exceeds 150% of the average value (`regionsizemb`). For example, if the average value is 4096 MB, MapR-DB splits a region that is larger than 6144 MB. \n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `splitmergeperm` permission on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-region-merge.html"
        }, 
        "parameters": [
          {
            "name": "fid", 
            "in": "query", 
            "description": "The FID for the table region that you want to merge. The output of `maprcli` [ `table region list` ](http://maprdocs.mapr.com/home/ReferenceGuide/table-region-list.html) lists the FIDs for the table.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table whose regions are being merged.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, if you want to merge regions for table named `test` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on a remote, you must also specify the cluster name in the path. For example, if you want to merge regions for table named `test` under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/region/pack": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Manually triggers the packing of regions.", 
        "description": "MapR-DB automatically packs regions; however, you can use this command to reclaim space that is consumed by expired rows or to avoid read amplification.\n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `packperm` permission on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-region-pack.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "Specifies the path to the table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, if you want to pack a table named `test` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, if you want to pack a table named `customer` under volume1 in the sanfrancisco cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "fid", 
            "in": "query", 
            "description": "Specifies that you want to pack all table regions or a single table region that you identify with a FID. The output of maprcli [table region list](http://maprdocs.mapr.com/home/ReferenceGuide/table-region-list.html) lists the FIDs for the table.", 
            "type": "string", 
            "enum": [
              "fid", 
              "all"
            ]
          }, 
          {
            "name": "nthreads", 
            "in": "query", 
            "description": "Specifies the number of threads allocated to process the packing of table regions. Default:16", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/region/split": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Splits a region in a table.", 
        "description": "## Permissions Required\n\n To run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on the volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the path \n* `splitmergeperm` permission on the table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-region-split.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "Path to the table.\n \n* For a path on the local cluster, start the path at the volume mount point. For example, if you want to split regions in a table named `test` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/test`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, if you want to split regions in a table named `customer` under volume1 in the sanfrancisco cluster, specify the following path:`/mapr/sanfrancisco/volume1/customer`", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "fid", 
            "in": "query", 
            "description": "The FID of the region to split. The output of `maprcli` [ `table region list` ](http://maprdocs.mapr.com/home/ReferenceGuide/table-region-list.html) lists the FIDs for the table's regions.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/add": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Registers a table as a replica of another MapR-DB binary or JSON table.", 
        "description": "Note: You do not need to use this command it you use the `table replica autosetup` command. \n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* `readAce` and `writeAce` on both the source volume and the target volume \n* `lookupdir` on directories in the paths of both tables  \n* `readperm` and `replperm` permissions on the source table \n\n \n\nNote: The **mapr user** is not treated as a superuser. MapR-DB does not allow the **mapr user** to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-add.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the source table that you want to replicate.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under a volume with a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n\n \n \n* For a table on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`  \n\n \n\nNote: For replication to a table, the command will fail if the table in the replica path does not exist.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "By default, all columns in the source table are replicated. \n\n \n\nIf you do not want to replicate all columns in the table, you can specify specific columns to replicate:  \n\n**For binary tables** \n\nProvide a comma-separated list of column families or columns from a certain column family (column family:qualifier). For example, use the following syntax to replicate the column family purchases and the column stars in the reviews column family: `-columns purchases,reviews:stars` \n\nNote: While the column families that you specify must already exist in the source table, the columns that you specify do not have to exist in the destination table for replication to succeed. If the column is added at a later date, replication for that column will start at that time. \n\n  \n\n**For JSON tables** \n\nProvide a comma-delimited list of fields to replicate. Include the full field path for each field. \n\n**Example**\n\n \n\nSuppose your table contains documents that contain this general structure:\n\n \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \n                    {\n                         \"c\" : \"value\",\n                    },\n               \"e\" : \"value\"\n          }\n}\n```\n\n\n\nTo replicate fields `a`, `c`, and `e`, you would specify these field paths:\n\n \n\n\n\n```\na,a.b.c,a.e\n```\n\nDo not use quotation marks and do not include spaces after commas. \n\n \n\nSuppose now that `a.b` and `a.e` were custom column families. You want to replicate only the default column family and column family `a.e`. To do so, you would specify field paths like this:\n\n \n\n```\n\",a.e\"\n```\n\n\n\nThe empty string before the comma indicates the default column family.", 
            "type": "string"
          }, 
          {
            "name": "paused", 
            "in": "query", 
            "description": "A Boolean value that specifies whether to pause the replication so that it does not start immediately. The replication can be resumed using the replica resume command at a later time. The values are `true` or false. Default: Not paused (`false`)", 
            "type": "boolean"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A Boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are true or false. Default: No throttle (`false`)", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. If you set this to `true`, the local cluster and any other cluster that is part of the replication process must be enabled for security. Default: No encryption (false)", 
            "type": "boolean"
          }, 
          {
            "name": "synchronous", 
            "in": "query", 
            "description": "A Boolean value that specifies whether replication is synchronous or asynchronous. The values are `true` or `false`. Default: Asynchronous (`false`)", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "The type of on-wire compression. Default: on\n\n \n\nThe types are:\n\n \n \n*  `off`  \n* on (default) \n*  `lzf`  \n*  `lz4`  \n*  `zlib`  \n\n \n\nlz4 is the default compression which it set by parameter values `on` or `lz4`.", 
            "type": "string", 
            "enum": [
              "off", 
              "on", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/autosetup": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Sets up and starts replication between a source MapR-DB binary or JSON table to a replica MapR-DB binary or JSON table.", 
        "description": "The `maprcli table replica autosetup` command performs the following steps to set up replication:\n\n \n \n1. Creates a table with the required column families in the destination cluster. \n1. Declares the new table to be a replica of the source table and ensures that replication does not begin immediately after the next step. \n1. Declares the source table as an upstream source for the replica. \n1. Runs the `CopyTable` utility to load a copy of the source data into the replica. \n1. Clears the paused replication state to start the replication stream. \n\n \n\n \n\n\n\n## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on both the source volume and the target volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the paths of both tables \n* `readperm` and `replperm` permissions on the source table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-autosetup.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the source table that you want to replicate.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under a volume with a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n* For a table on another cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst `under`volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`  \n\n \n\nNote: For replication to a table, the command will fail if the replica path you specify points to table that already exists.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "By default, all columns in the source table are replicated. \n\n \n\nIf you do not want to replicate all columns in the table, you can specify specific columns to replicate:  \n\n**For binary tables** \n\nProvide a comma-separated list of column families or columns from a certain column family (column family:qualifier). For example, use the following syntax to replicate the column family purchases and the column stars in the reviews column family: `-columns purchases,reviews:stars` \n\nNote: While the column families that you specify must already exist in the source table, the columns that you specify do not have to exist in the destination table for replication to succeed. If the column is added at a later date, replication for that column will start at that time. \n\n  \n\n**For JSON tables** \n\nProvide a comma-delimited list of fields to replicate. Include the full field path for each field. \n\n**Example**\n\n \n\nSuppose your table contains documents that contain this general structure:\n\n \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \n                    {\n                         \"c\" : \"value\",\n                    },\n               \"e\" : \"value\"\n          }\n}\n```\n\n\n\nTo replicate fields `a`, `c`, and `e`, you would specify these field paths:\n\n \n\n\n\n```\na,a.b.c,a.e\n```\n\nDo not use quotation marks and do not include spaces after commas. \n\n \n\nSuppose now that `a.b` and `a.e` were custom column families. You want to replicate only the default column family and column family `a.e`. To do so, you would specify field paths like this:\n\n \n\n```\n\",a.e\"\n```\n\n\n\nThe empty string before the comma indicates the default column family.", 
            "type": "string"
          }, 
          {
            "name": "synchronous", 
            "in": "query", 
            "description": "A Boolean value that specifies whether replication is synchronous or asynchronous. The values are `true` or `false.` Asynchronous (`false`) is the default.", 
            "type": "boolean"
          }, 
          {
            "name": "multimaster", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to set up a multi-master topology. The values are `true` or `false.` Basic master-slave topology (`false`) is the default.", 
            "type": "boolean"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are true or false. No throttle (`false`) is the default.", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. No encryption `(false)` is the default`.` If you set this to `true`, the local cluster and any other cluster that is part of the replication process must be enabled for security.", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "The type of on-wire compression.\n\n \n\nThe types are:\n\n \n \n* off \n*  `on` (default) \n*  `lzf`  \n*  `lz4`  \n*  `zlib`  \n\n \n\nlz4 is the default compression which it set by parameter values ` on `or` lz4. `", 
            "type": "string", 
            "enum": [
              "off", 
              "on", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/edit": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Edits the properties of a replica of a MapR-DB binary or JSON table.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* `readAce` and `writeAce` on both the source volume and the target volume \n* `lookupdir` on directories in the paths of both tables  \n* `readperm` and `replperm` permissions on the source table \n\n \n\nNote: The **mapr user** is not treated as a superuser. MapR-DB does not allow the **mapr user** to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-edit.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the source table that you want to replicate.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under a volume with a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n\n \n \n* For a table on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }, 
          {
            "name": "newreplica", 
            "in": "query", 
            "description": "The updated replica path due to a renamed replica table, renamed cluster, or changed table path. The table specified in the `replica` parameter and the table specified in the `newreplica` parameter must have the same UUID.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "By default, all columns in the source table are replicated. \n\n \n\nIf you do not want to replicate all columns in the table, you can specify specific columns to replicate:  \n\n**For binary tables** \n\nProvide a comma-separated list of column families or columns from a certain column family (column family:qualifier). For example, use the following syntax to replicate the column family purchases and the column stars in the reviews column family: `-columns purchases,reviews:stars` \n\nNote: While the column families that you specify must already exist in the source table, the columns that you specify do not have to exist in the destination table for replication to succeed. If the column is added at a later date, replication for that column will start at that time. \n\n  \n\n**For JSON tables** \n\nProvide a comma-delimited list of fields to replicate. Include the full field path for each field. \n\n**Example**\n\n \n\nSuppose your table contains documents that contain this general structure:\n\n \n\n```\n{\n     \"_id\" : \"ID\",\n     \"a\" :\n          {\n               \"b\" : \n                    {\n                         \"c\" : \"value\",\n                    },\n               \"e\" : \"value\"\n          }\n}\n```\n\n\n\nTo replicate fields `a`, `c`, and `e`, you would specify these field paths:\n\n \n\n\n\n```\na,a.b.c,a.e\n```\n\nDo not use quotation marks and do not include spaces after commas. \n\n \n\nSuppose now that `a.b` and `a.e` were custom column families. You want to replicate only the default column family and column family `a.e`. To do so, you would specify field paths like this:\n\n \n\n```\n\",a.e\"\n```\n\n\n\nThe empty string before the comma indicates the default column family.", 
            "type": "string"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are true or false. No throttle (`false`) is the default.", 
            "type": "string"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false.` No encryption `(false)` is the default`.` If you set this to true, the local cluster and any other cluster that is part of the replication process must be enabled for security.", 
            "type": "string"
          }, 
          {
            "name": "synchronous", 
            "in": "query", 
            "description": "A Boolean value that specifies whether replication is synchronous or asynchronous. The values are `true` or `false.` Asynchronous (`false`) is the default.", 
            "type": "string"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "The type of on-wire compression.\n\n \n\nThe types are:\n\n \n \n* off \n* on (default) \n*  `lzf`  \n*  `lz4.` This is the default \n*  `zlib`  \n\n \n\nlz4 is the default compression which it set by parameter values on or lz4.", 
            "type": "string", 
            "enum": [
              "off", 
              "on", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/list": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Lists replicas and the associated replica statistics for a specified MapR-DB binary or JSON table. By default, replica statistics are updated every five minutes.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* `readAce` on the volume \n* `lookupdir` on directories in the path  \n\n \n\nNote: The **mapr user** is not treated as a superuser. MapR-DB does not allow the **mapr user** to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table that you want to list replicas for.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a table on another cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco`cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "refreshnow", 
            "in": "query", 
            "description": "A Boolean value that specifies if you want to trigger an immediate update of the replica statistics. The values are `true` or `false`. By default, the value is `false`; the command lists the current version of the replica statistics, which could be a maximum of five minutes old.", 
            "type": "boolean"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/pause": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Pauses the replication of data from a source MapR-DB binary or JSON table to a replica MapR-DB binary or JSON table.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on both the source volume and the target volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the paths of both tables \n* `replperm` permissions on the source table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-pause.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the source table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under a volume with a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path to the replica that will receive updates from the source.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n* For a table on another cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/remove": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Un-registers the specified MapR-DB binary or JSON table as a replica.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on both the source volume and the target volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the paths of both tables \n* `replperm` permissions on the source table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-remove.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the source table that is being replicated.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under a volume with a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n\n \n \n* For a table on another cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/resume": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Resumes replication between a source MapR-DB binary or JSON table and a replica of that table when the replication state is set to paused by the maprcli table replica add or the maprcli table replica pause command.", 
        "description": "## Permissions Required\n\nTo run this command, your user ID must have the following permissions:\n \n* [`readAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) and [`writeAce`](http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html#volumemodify) on both the source volume and the target volume \n* [`lookupdir`](http://maprdocs.mapr.com/home/ReferenceGuide/hadoop-mfs.html#hadoopmfs) on directories in the paths of both tables \n* `replperm` permissions on the source table \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-resume.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table that will be replicated.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under a volume with a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }, 
          {
            "name": "replica", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n\n \n \n* For a table on another cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/elasticsearch/autosetup": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Maps a MapR-DB source binary table to an Elasticsearch type.", 
        "description": "The type can already exist, as would be the case if custom mapping of MapR-DB data to Elasticsearch-supported data types is configured. If the type doesn't already exist, this command creates it and then loads data from the source table into the type.\n\n \n\nThe final action of this command is to start replication from the source table to the type.\n\n \n\nThe user that runs the command must have the following permissions granted through access control expressions on the source table:\n\n \n \n* Permission to perform column-family and column reads, which is granted with the `readperm` access control expression. \n* Permission to perform replication, which is granted with the `replperm` access control expression. \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-autosetup.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the new MapR-DB table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "target", 
            "in": "query", 
            "description": "The name of the Elasticsearch cluster that you want to index data in. This name is the name specified for the cluster when it was registered with the current MapR cluster.", 
            "type": "string"
          }, 
          {
            "name": "index", 
            "in": "query", 
            "description": "The name of the Elasticsearch index in which the type is located (if the type exists) or will be created (if it does not exist).", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The name of the Elasticsearch type. Updates to the MapR-DB source table will be replicated to this type.", 
            "type": "string"
          }, 
          {
            "name": "conversionclass", 
            "in": "query", 
            "description": "The name of the Java class that extends the MapR-provided interface `MapRESConverter` and specifies how to convert source data to Elasticsearch-supported data types that MapR-DB does not support. For more information about custom mapping of source data types to Elasticsearch-supported data types, see [Converting Data to Elasticsearch Data Types That MapR-DB Does Not Support](http://maprdocs.mapr.com/home/MapR-DB/ConvertingDatatoNonsupportedESTypes.html).\n\n \n\nIf use this parameter, you must also use the `conversionjar` parameter.", 
            "type": "string"
          }, 
          {
            "name": "conversionjar", 
            "in": "query", 
            "description": "The path to the JAR file in which the class specified by the `conversionclass` parameter is located.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of column families and specific columns within column families. This list indicates which columns to replicate to the Elasticsearch type that is specified by the type parameter.\n\n \n\nTo replicate all columns within a column family, provide the name of the column family.\n\n \n\nTo replicate particular columns within a column family, provide the name of the column family and the name of the column. Separate the two with a colon.\n\n \n\nFor example, the following list causes the replication of all columns in the column family `personal`, all columns in the column family `purchase`, the `number_of_stars` column in the column family `review`, and the `date` column in the column family `review`:\n\n \n\n `-columns personal,purchase,review:number_of_stars,review:date`", 
            "type": "string"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A Boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are true or false. No throttle (false) is the default.", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. No encryption (false) is the default. If you set this to true, the source MapR cluster must be enabled for security.\n\n \n\nNote: Data is encrypted only until it reaches a MapR gateway. From the gateway to an Elasticsearch cluster, this parameter has no effect.", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "The type of on-wire compression.\n\n \n\nThe types are:\n\n \n \n*  `off`  \n*  `on` (default) \n*  `lzf`  \n*  `lz4`  \n*  `zlib`  \n\n \n\nlz4 is the default compression which it set by the parameter values `on` and `lz4`.\n\n \n\nNote: Data is compressed only until it reaches a MapR gateway. From the gateway to an Elasticsearch cluster, this parameter has no effect.", 
            "type": "string", 
            "enum": [
              "off", 
              "on", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/elasticsearch/edit": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Edits the mapping of a MapR-DB source binary table to an Elasticsearch type.", 
        "description": "The user that runs the command must have the following permissions granted through access control expressions on the source table:\n\n \n \n* Permission to perform column-family and column reads, which is granted with the `readperm` access control expression. \n* Permission to perform replication, which is granted with the `replperm` access control expression. \n\n \n\nNote: The `mapr` user is not treated as a superuser. MapR-DB does not allow the `mapr` user to run this command unless that user is given the relevant permission or permissions with access-control expressions.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-edit.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the MapR-DB table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "target", 
            "in": "query", 
            "description": "The name of the Elasticsearch cluster in which the index and type are located. This name is the name specified for the cluster when it was registered with the current MapR cluster.", 
            "type": "string"
          }, 
          {
            "name": "index", 
            "in": "query", 
            "description": "The name of the Elasticsearch index in which the type is located.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The name of the Elasticsearch type that updates to the MapR-DB source table are being replicated to.", 
            "type": "string"
          }, 
          {
            "name": "conversionclass", 
            "in": "query", 
            "description": "The name of the Java class that extends the MapR-provided interface `MapRESConverter` and specifies how to convert source data to Elasticsearch-supported data types that MapR-DB does not support. For more information about custom mapping of source data types to Elasticsearch-supported data types, see [ Converting Data to Elasticsearch Data Types That MapR-DB Does Not Support](http://maprdocs.mapr.com/home/MapR-DB/ConvertingDatatoNonsupportedESTypes.html).\n\n \n\nIf use this parameter, you must also use the `conversionjar` parameter.", 
            "type": "string"
          }, 
          {
            "name": "conversionjar", 
            "in": "query", 
            "description": "The path to the JAR file in which the class specified by the `conversionclass` parameter is located.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of column families and specific columns within column families. This list indicates which columns to replicate to the Elasticsearch type that is specified by the type parameter.\n\n \n\nTo replicate all columns within a column family, provide the name of the column family.\n\n \n\nTo replicate particular columns within a column family, provide the name of the column family and the name of the column. Separate the two with a colon.\n\n \n\nFor example, the following list causes the replication of all columns in the column family `personal`, all columns in the column family `purchase`, the `number_of_stars` column in the column family `review`, and the `date` column in the column family `review`:\n\n \n\n `-columns personal,purchase,review:number_of_stars,review:date` \n\n \n\nIf you change the list by removing any columns or column families that have already been replicated to the Elasticsearch type, those columns and column families are not deleted from the type. MapR-DB replicates updates only; it does not replicate deletions or remove data from Elasticsearch types. If you do not want to keep the data in the type, follow these steps:\n\n \n \n1. On the source MapR cluster, remove the mapping of the source table to the type by running the command [ `maprcli table replica elasticsearch remove` ](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-remove.html). If the source table is being indexed in more than one type, and those types also contain the columns and column families that you are no longer indexing, run the command [maprcli table replica elasticsearch list](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-list.html) to list all of the types that are mapped to the source table. Then, run the command  [`maprcli table replica elasticsearch remove`](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-remove.html)  for each type. \n1. In Elasticsearch, delete all of the types that were mapped to the source table. \n1. On the source MapR cluster, recreate each type and restart indexing by running the command  [`maprcli table replica elasticsearch autosetup`](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-autosetup.html)  for each type. \n\n \n\nNote: To copy the content of the source table into the type, the `maprcli table replica elasticsearch autosetup` command starts a MapReduce job. The length of the job depends on the size of the source table and the number of columns that you are indexing. Moreover, the volume of data and the speed at which the Elasticsearch type is populated could perceptibly slow the performance of other processes running at the same time on the Elasticsearch cluster. The less data there is to copy to the type, the faster the MapReduce job will end and the fewer resources the job will consume on the Elasticsearch cluster.", 
            "type": "string"
          }, 
          {
            "name": "throttle", 
            "in": "query", 
            "description": "A Boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are true or false. No throttle (false) is the default.", 
            "type": "boolean"
          }, 
          {
            "name": "networkencryption", 
            "in": "query", 
            "description": "A Boolean value that specifies whether or not to enable on-wire encryption. The values are `true` or `false`. No encryption (false) is the default. If you set this to true, the local cluster and any other cluster that is part of the replication process must be enabled for security.\n\n \n\nNote: Data is encrypted only until it reaches a MapR gateway. From the gateway to an Elasticsearch cluster, this parameter has no effect.", 
            "type": "boolean"
          }, 
          {
            "name": "networkcompression", 
            "in": "query", 
            "description": "The type of on-wire compression.\n\n \n\nThe types are:\n\n \n \n* off \n* on (default) \n* lzf \n* lz4 \n* zlib \n\n \n\nlz4 is the default compression which it set by the parameter values `on` and `lz4`.\n\n \n\nNote: Data is compressed only until it reaches a MapR gateway. From the gateway to an Elasticsearch cluster, this parameter has no effect.", 
            "type": "string", 
            "enum": [
              "off", 
              "on", 
              "lzf", 
              "lz4", 
              "zlib"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/elasticsearch/list": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Lists the Elasticsearch types and the associated replication statistics for a specified binary table.", 
        "description": "By default, statistics are updated every five minutes.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the table that you want to list the Elasticsearch types for.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "refreshnow", 
            "in": "query", 
            "description": "A Boolean value that specifies if you want to trigger an immediate update of the replication statistics. The values are `true` or `false`. By default, the value is false; the command lists the current version of the replication statistics, which could be a maximum of five minutes old.", 
            "type": "boolean"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/elasticsearch/pause": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Pauses replication to an Elasticsearch type from a MapR-DB source binary table.", 
        "description": "Two reasons that you might want to pause replication are:\n\n \n \n* You want to run [ `maprcli table replica elasticsearch remove` ](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-remove.html) to remove the mapping from a source table to a type that is currently receiving replicated updates. \n* You want to compare the data in the type to the data in the source table by using the [ `DiffTables` ](http://maprdocs.mapr.com/home/ReferenceGuide/DiffTables.html) utility. \n\n \n\nTo resume replication to a type, run the  [`maprcli table replica elasticsearch resume`](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-resume.html)  command.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-pause.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the MapR-DB source table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "target", 
            "in": "query", 
            "description": "The name of the Elasticsearch cluster in which to create the new type. This name is the name specified for the cluster when it was registered with the current MapR cluster.", 
            "type": "string"
          }, 
          {
            "name": "index", 
            "in": "query", 
            "description": "The name of the Elasticsearch index in which the type is located.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The name of the Elasticsearch type that updates to the MapR-DB source table are being replicated to.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/elasticsearch/resume": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Resumes replication to an Elasticsearch type from a MapR-DB source binary table.", 
        "description": "The result of this command is the opposite of the command [ `maprcli table replica elasticsearch pause` ](http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-pause.html).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-resume.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the MapR-DB source table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "target", 
            "in": "query", 
            "description": "The name of the Elasticsearch cluster in which to create the new type. This name is the name specified for the cluster when it was registered with the current MapR cluster.", 
            "type": "string"
          }, 
          {
            "name": "index", 
            "in": "query", 
            "description": "The name of the Elasticsearch index in which the type is located.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The name of the Elasticsearch type that updates to the MapR-DB source table are being replicated to.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/replica/elasticsearch/remove": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Removes the mapping from a MapR-DB source binary table to an Elasticsearch type.", 
        "description": "Updates from the table will no longer be replicated to the type. The type is not removed from the Elasticsearch cluster in which it is located.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-replica-elasticsearch-remove.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the MapR-DB source table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `test` under a volume with a mount point at `/volume1`, specify the following path: `/volume1/test`  \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customer` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customer`", 
            "type": "string"
          }, 
          {
            "name": "target", 
            "in": "query", 
            "description": "The name of the Elasticsearch cluster in which the type being replicated to is located. This name is the name specified for the cluster when it was registered with the current MapR cluster.", 
            "type": "string"
          }, 
          {
            "name": "index", 
            "in": "query", 
            "description": "The name of the Elasticsearch index in which the type is located.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The name of the Elasticsearch type that updates to the MapR-DB source table are being replicated to.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/upstream/add": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Adds a binary table as upstream source for a replica.", 
        "description": "Note: You do not need to use this command if you use the `table replica autosetup` command.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-upstream-add.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a path to a table on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/testdst`  \n\n \n \n* For a path to a table on a remote cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under volume1 in the sanfrancisco cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }, 
          {
            "name": "upstream", 
            "in": "query", 
            "description": "The path to the source table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under volume1 which has a mount point at /volume1, specify the following path: `/volume1/testsrc`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under volume1 in the sanfrancisco cluster, specify the following path: `/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/upstream/list": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Lists the binary tables that replicate data to the specified replica binary table.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-upstream-list.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under `volume1` which has a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n\n \n \n* For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named customerdst under `volume1` in the `sanfrancisco` cluster, specify the following path:`/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/table/upstream/remove": {
      "get": {
        "tags": [
          "table"
        ], 
        "summary": "Un-registers a binary table as an upstream source for a replica.", 
        "description": "Note: This step is separate from the `table replica remove` command, which stops replication updates to a replica.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/table-upstream-remove.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The path to the replica.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testdst` under `volume1` which has a mount point at `/volume1`, specify the following path: `/volume1/testdst`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customerdst` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customerdst`", 
            "type": "string"
          }, 
          {
            "name": "upstream", 
            "in": "query", 
            "description": "The path to the source table.\n\n \n \n* For a path on the local cluster, start the path at the volume mount point. For example, for a table named `testsrc` under `volume1` which has a mount point at `/volume1`, specify the following path: `/volume1/testsrc`  \n\n \n \n* For a path on another cluster, you must also specify the cluster name in the path. For example, for a table named `customersrc` under `volume1` in the `sanfrancisco` cluster, specify the following path: `/mapr/sanfrancisco/volume1/customersrc`", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/task/failattempt": {
      "get": {
        "tags": [
          "task"
        ], 
        "summary": "Ends the specified task attempt as failed.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/task-failattempt.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "Cluster name", 
            "type": "string"
          }, 
          {
            "name": "taskattemptid", 
            "in": "query", 
            "description": "Task attempt ID", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/task/killattempt": {
      "get": {
        "tags": [
          "task"
        ], 
        "summary": "Kills the specified task attempt.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/task-killattempt.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "Cluster name", 
            "type": "string"
          }, 
          {
            "name": "taskattemptid", 
            "in": "query", 
            "description": "Task attempt ID", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/task/table": {
      "get": {
        "tags": [
          "task"
        ], 
        "summary": "Retrieves histograms and line charts for task metrics.", 
        "description": "A Hadoop job sets the rules that the JobTracker service uses to break an input data set into discrete tasks and assign those tasks to individual nodes. Use the `task table` to retrieve [task analytics](http://maprdocs.mapr.com/home/AdministratorGuide/JobMetrics-Analyzing.html#Analyzing-Job-Metrics-TheMapRMetricsservic-d3e72) about the jobs running on your cluster. The task metric data includes information about the tasks that make up a specific job, as well as the specific task attempts. The job metric data includes a task attempt's data throughput, measured in number of records per second as well as in bytes per second. The metrics data can be formatted for histogram display or line chart display. In order to issue the `task table` command, the mapr-metrics package must be installed on all the nodes where webserver and jobtracker are configured to run.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/task-table.html"
        }, 
        "parameters": [
          {
            "name": "filter", 
            "in": "query", 
            "description": "Filters results to match the value of a specified string.", 
            "type": "string"
          }, 
          {
            "name": "chart", 
            "in": "query", 
            "description": "Chart type to use: `line` for a line chart, `bar` for a histogram.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "Comma-separated list of column names to return.", 
            "type": "string"
          }, 
          {
            "name": "bincount", 
            "in": "query", 
            "description": "Number of histogram bins.", 
            "type": "string"
          }, 
          {
            "name": "scale", 
            "in": "query", 
            "description": "Scale to use for the histogram. Specify `linear` for a linear scale and `log` for a logarithmic scale.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/urls/{name}": {
      "get": {
        "tags": [
          "urls"
        ], 
        "summary": "Displays the status page URL for the specified service.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/urls.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster on which to save the configuration.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "path", 
            "description": "The name of the service for which to get the status page:\n\n \n \n* cldb \n* jobtracker \n* tasktracker", 
            "required": true, 
            "type": "string", 
            "enum": [
              "cldb", 
              "jobtracker", 
              "tasktracker"
            ]
          }, 
          {
            "name": "zkconnect", 
            "in": "query", 
            "description": "[ZooKeeper Connect String](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-CommonParameters.html#concept_ymb_yxz_5t)", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/virtualip/add": {
      "get": {
        "tags": [
          "virtualip"
        ], 
        "summary": "Adds a virtual IP address. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/virtualip-add.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "gateway", 
            "in": "query", 
            "description": "The NFS gateway IP or address", 
            "type": "string"
          }, 
          {
            "name": "macs", 
            "in": "query", 
            "description": "A list of the MAC addresses that represent the NICs on the nodes that the VIPs in the VIP range can be associated with. Use this list to limit VIP assignment to NICs on a particular subnet when your NFS server is part of multiple subnets.", 
            "type": "string"
          }, 
          {
            "name": "netmask", 
            "in": "query", 
            "description": "The netmask of the virtual IP.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "virtualip", 
            "in": "query", 
            "description": "The virtual IP, or the start of the virtual IP range.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "virtualipend", 
            "in": "query", 
            "description": "The end of the virtual IP range.", 
            "type": "string"
          }, 
          {
            "name": "preferredmac", 
            "in": "query", 
            "description": "The preferred MAC for this virtual IP. When an NFS server restarts, the MapR system attempts to move all of the virtual IP addresses that list a MAC address on this node as a preferred MAC to this node. If the new value is null, this parameter resets the preferred MAC value.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/virtualip/edit": {
      "get": {
        "tags": [
          "virtualip"
        ], 
        "summary": "Edits a virtual IP (VIP) range. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/virtualip-edit.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "macs", 
            "in": "query", 
            "description": "A list of the MAC addresses that represent the NICs on the nodes that the VIPs in the VIP range can be associated with. Use this list to limit VIP assignment to NICs on a particular subnet when your NFS server is part of multiple subnets.", 
            "type": "string"
          }, 
          {
            "name": "netmask", 
            "in": "query", 
            "description": "The netmask of the virtual IP.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "virtualip", 
            "in": "query", 
            "description": "The virtual IP, or the start of the virtual IP range.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "virtualipend", 
            "in": "query", 
            "description": "The end of the virtual IP range.", 
            "type": "string"
          }, 
          {
            "name": "preferredmac", 
            "in": "query", 
            "description": "The preferred MAC for this virtual IP. When an NFS server restarts, the MapR system attempts to move all of the virtual IP addresses that list a MAC address on this node as a preferred MAC to this node. If the new value is null, this parameter resets the preferred MAC value.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/virtualip/list": {
      "get": {
        "tags": [
          "virtualip"
        ], 
        "summary": "Lists the virtual IP addresses in the cluster.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/virtualip-list.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "The columns to display. Note that the hostname and ip fields are always returned in the query.", 
            "type": "string"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying VIPs to list. See [Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) for more information.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of records to return.", 
            "type": "string"
          }, 
          {
            "name": "nfsmacs", 
            "in": "query", 
            "description": "The MAC addresses of servers running NFS.", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Whether the output should be `terse` or `verbose`.", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "range", 
            "in": "query", 
            "description": "The VIP range.", 
            "type": "string"
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The index of the first record to return.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/virtualip/move": {
      "get": {
        "tags": [
          "virtualip"
        ], 
        "summary": "Reassigns a virtual IP or a range of virtual IP addresses to a specified Media Access Control (MAC) address.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/virtualip-move.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster where the virtual IP addresses are being moved.", 
            "type": "string"
          }, 
          {
            "name": "virtualip", 
            "in": "query", 
            "description": "A virtual IP address. If you provide a value for `-virtualipend`, this virtual IP address defines the beginning of the range.", 
            "type": "string"
          }, 
          {
            "name": "virtualipend", 
            "in": "query", 
            "description": "A virtual IP address that defines the end of a virtual IP address range.", 
            "type": "string"
          }, 
          {
            "name": "tomac", 
            "in": "query", 
            "description": "The MAC address that the virtual IP addresses are being assigned.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/virtualip/remove": {
      "get": {
        "tags": [
          "virtualip"
        ], 
        "summary": "Removes a virtual IP (VIP) or a VIP range. Permissions required: fc or a .", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/virtualip-remove.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "virtualip", 
            "in": "query", 
            "description": "The virtual IP or the start of the VIP range to remove.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "virtualipend", 
            "in": "query", 
            "description": "The end of the VIP range to remove.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/audit": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Enables or disables auditing on the specified volume.", 
        "description": "You must have the `fc` permission on the cluster to use this command. See [`acl`](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html#acl) for details about this permission.\n\n \n\nTo learn how to determine whether auditing is enabled for a volume, see [Checking Whether Auditing is Enabled for a Directory, File, or MapR-DB Table](http://maprdocs.mapr.com/home/SecurityGuide/CheckingWhetherAuditingisEnabled.html#CheckingWhetherAuditingisEnabledforaDirectoryFileorMapR-DBTable).", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-audit.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which the volume is located. This parameter is required if the volume is on a remote cluster. The remote cluster must be listed in the mapr-cluster.conf file for the cluster where you run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the volume.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "enabled", 
            "in": "query", 
            "description": "Enables or disables the auditing of operations within the volume. You must use either this parameter, the `-coalesce` parameter, or both.\n\n \n\nSee [Enabling Auditing](http://maprdocs.mapr.com/home/SecurityGuide/Auditing-Prerequisites.html#EnablingAuditing) for the steps to enable auditing on directories, files, and tables in a volume.\n\n \n\nWhen you set the value to false, auditing of operations within the volume ceases. None of the auditing settings are changed on the directories, files, and MapR-DB tables within the volume. If you later run the `maprcli volume audit` command with `-enabled` set to `true`, auditing begins again on the objects that were already enabled for auditing.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "coalesce", 
            "in": "query", 
            "description": "The interval of time during which READ, WRITE, or GETATTR operations on one file from one client IP address are logged only once, if auditing is enabled.\n\n \n\nFor example, suppose that a client application reads a single file three times in 6 minutes, so that there is one read at 0 minutes, another at 3 minutes, and a final read at 6 minutes. If the coalesce interval is at least 6 minutes, then only the first read operation is logged. However, if the interval is between 4 minutes, then only the first and third read operations are logged. If the interval is 2 minutes, all three read operations are logged.\n\n \n\nThe default value is 60 minutes. Setting this field to a larger number helps prevent audit logs from growing quickly.", 
            "type": "string"
          }, 
          {
            "name": "dataauditops", 
            "in": "query", 
            "description": "The comma separated list of filesystem operations to include (specified with a preceding plus sign (`+`)) and/or exclude (specified with a preceding minus sign (`-`)) from auditing. \n\n \n\nNote: If the first operation in the list is to be excluded from auditing, it must be preceded by two minus (`--`) signs. Subsequent operations to exclude must be preceded by only a single minus (`-`) sign, whether or not the first operation was included (using a plus (`+`) sign) or excluded (using two minus (`--`) signs). If neither sign is specified, the given operation is included for auditing.\n\n \n\nThe operations that can be included (`+`) and/or excluded (`-`) from auditing are listed [here](http://maprdocs.mapr.com/home/SecurityGuide/Auditing-FilesystemTableOperations.html#AuditingofFilesystemOperationsandTableOperations). You can, alternatively, group all the filesystem and table operations using the keyword `all`, which:\n\n \n \n* If included (`+`), cannot be specified with a list of other included operations. \n* If excluded (`-`), cannot be specified with a list of other excluded operations. \n\n \n\nNote: You can specify a mixed list of included and excluded operations. There are no changes to operations that are not specified with the command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/container/move": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Moves a container. Permissions required: fc or m on the volume.", 
        "description": "The volume container move command moves a specified container (`cid`) from a source file server (`fromfileserver`) to a destination file server (`tofileserver`). If the `tofileserver` parameter is not specified, a destination file server is chosen by the CLDB. If the `tofileserver` is specified but does not exist, the command fails with an error. If the `fromfileserver` does not exist or is down, the container move occurs once the source file server comes back up.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-container-move.html"
        }, 
        "parameters": [
          {
            "name": "cid", 
            "in": "query", 
            "description": "The container ID.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "fromfileserverid", 
            "in": "query", 
            "description": "The ID of the file server on which the container to be moved currently resides. The ID is available from the maprcli node list command.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "tofileserverid", 
            "in": "query", 
            "description": "The ID of the file server to which to move the container. If not specified, a file server is chosen by the CLDB. The ID is available from the maprcli node list command.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/container/switchmaster": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Switches the master replica for a specified container to another replica in the replica chain.", 
        "description": "This command fails if there is only one up-to-date replica for the container.\n\n \n\nNote: Only the root and the MAPR_USER (user name under which MapR services runs) user have permissions to run this command.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-container-switchmaster.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command. If this parameter is omitted, the command is run on the same cluster where it is issued. In multi-cluster contexts, you can use this parameter to specify a different cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "cid", 
            "in": "query", 
            "description": "The unique ID number for the container that you want to run the command on.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/create": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Creates a volume. Permissions required: cv or fc on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-create.html"
        }, 
        "parameters": [
          {
            "name": "advisoryquota", 
            "in": "query", 
            "description": "The advisory quota for the volume as `integer` plus `unit. Example: quota=500G; Units:` `B`, `K`, `M`, `G`, `T`, `P`", 
            "type": "string"
          }, 
          {
            "name": "ae", 
            "in": "query", 
            "description": "The accounting entity that owns the volume.", 
            "type": "string"
          }, 
          {
            "name": "aetype", 
            "in": "query", 
            "description": "The type of accounting entity:\n\n \n \n*  `0`=`user`  \n*  `1`=`group`", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "allowgrant", 
            "in": "query", 
            "description": "Specifies whether a parent volume grants permission for a child volume to inherit its properties. True or false.\n\n \n\nDefault: false.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "allowinherit", 
            "in": "query", 
            "description": "Specifies whether a new volume inherit sproperties from the parent mount point volume. True or false. Default: true.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "auditenabled", 
            "in": "query", 
            "description": "Specifies whether to turn auditing on for the volume. If auditing is also enabled at the cluster level with the `maprcli audit data` command, setting this value to `true` causes auditing to start for any directories, files, or tables that are already enabled for auditing. If none are yet so enabled, subsequently enabling auditing on any of them causes auditing of them to start.\n\n \n\nYou must have the `fc` permission on the cluster to use this parameter. See `acl` for details about this permission.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to create the volume.", 
            "type": "string"
          }, 
          {
            "name": "coalesce", 
            "in": "query", 
            "description": "The interval of time during which READ, WRITE, or GETATTR operations on one file from one client IP address are logged only once, if auditing is enabled.\n\n \n\nFor example, suppose that a client application reads a single file three times in 6 minutes, so that there is one read at 0 minutes, another at 3 minutes, and a final read at 6 minutes. If the coalesce interval is at least 6 minutes, then only the first read operation is logged. However, if the interval is between 4 minutes, then only the first and third read operations are logged. If the interval is 2 minutes, all three read operations are logged.\n\n \n\nThe default value is 60 minutes. Setting this field to a larger number helps prevent audit logs from growing quickly.", 
            "type": "string"
          }, 
          {
            "name": "createparent", 
            "in": "query", 
            "description": "Specifies whether or not to create a parent directory to hold the volume link:\n\n \n \n*  `0` = Do not create a parent directory. \n*  `1` = Create a parent directory.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "dataauditops", 
            "in": "query", 
            "description": "The comma separated list of filesystem operations to include (specified with a preceding plus sign (`+`)) or exclude (specified with a preceding minus sign (`-`)) from auditing. \n\n \n\nNote: If the first operation in the list (of operations) is to be excluded from auditing, it must be preceded by two minus (`--`) signs. Subsequent operations to exclude must be preceded by only a single minus (`-`) sign, whether or not the first operation was included (using a plus (`+`) sign) or excluded (using two minus (`--`) signs). If neither sign is specified, the given operation is included for auditing.\n\n \n\nThe operations that can be included (`+`) or excluded (`-`) from auditing are listed in [Auditing Operations](http://maprdocs.mapr.com/home/SecurityGuide/Auditing-FilesystemTableOperations.html). You can, alternatively, group all the operations using the keyword `all`, which: \n \n* If included (`+`), cannot be specified with a list of other included operations. \n* If excluded (`-`), cannot be specified with a list of other excluded operations. \n\n \n\n \n\nNote: All specified operations must either be included or excluded from auditing. You cannot specify a mixed list of included and excluded operations. \n\n \n\nOther than the specified operations, by default, all other operations will be: \n \n* Included for auditing if the specified list is a list of excluded operations. \n* Excluded from auditing if the specified list is a list of included operations. \n\n \n\n \n\nTip: For more information, see [Selective Auditing of Filesystem and Table Operations](http://maprdocs.mapr.com/home/SecurityGuide/SelectiveAuditingOfOperations.html#concept_nzd_j5g_h5).", 
            "type": "string"
          }, 
          {
            "name": "dbrepllagsecalarmthresh", 
            "in": "query", 
            "description": "Specifies the threshold to raise alarm for DB replication lag.", 
            "type": "string"
          }, 
          {
            "name": "group", 
            "in": "query", 
            "description": "Space-separated list of `group:permission` pairs.", 
            "type": "string"
          }, 
          {
            "name": "inherit", 
            "in": "query", 
            "description": "Specifies the name of the volume from which the new volume will inherit properties. When `inherit` is explicitly specified, `allowgrant` is not required. See the following section on Inheritance for more information.", 
            "type": "string"
          }, 
          {
            "name": "localvolumehost", 
            "in": "query", 
            "description": "The local volume host.", 
            "type": "string"
          }, 
          {
            "name": "localvolumeport", 
            "in": "query", 
            "description": "The local volume port. Default: 5660", 
            "type": "string"
          }, 
          {
            "name": "maxinodesalarmthreshold", 
            "in": "query", 
            "description": "Threshold for the [ INODES_EXCEEDED](http://maprdocs.mapr.com/home/ReferenceGuide/VolumeAlarms.html) alarm.", 
            "type": "string"
          }, 
          {
            "name": "minreplication", 
            "in": "query", 
            "description": "The minimum replication level. Default: 2 When the replication factor falls below this minimum, re-replication occurs as aggressively as possible to restore the replication level. If any containers in the CLDB volume fall below the minimum replication factor, writes are disabled until aggressive re-replication restores the minimum level of replication. \n\nTip: For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "mirrorschedule", 
            "in": "query", 
            "description": "The ID of a mirror schedule. If a mirror schedule ID is provided, then the mirror volume will automatically sync with its source volume on the specified schedule.", 
            "type": "string"
          }, 
          {
            "name": "mirrorthrottle", 
            "in": "query", 
            "description": "Specifies whether throttling should be enabled at create time.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "mount", 
            "in": "query", 
            "description": "Specifies whether the volume is mounted at creation time.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the volume to create.", 
            "type": "string"
          }, 
          {
            "name": "nsminreplication", 
            "in": "query", 
            "description": "The minimum replication level for the namespace container. Default: 2 When the replication factor falls below this minimum, re-replication occurs as aggressively as possible to restore the replication level. If any containers in the CLDB volume fall below the minimum replication factor, writes are disabled until aggressive re-replication restores the minimum level of replication. When enabled, the CLDB manages the namespace container replication separate from the data container replication. This capability is used when you have low volume replication but want to have higher namespace replication. \n\nNote: This parameter must be the same or larger than the equivalent data replication parameter, `minreplication`.\n\n For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "nsreplication", 
            "in": "query", 
            "description": "The desired namespace container replication level. Default: 3. When the number of copies falls below the desired replication factor, but remains equal to or above the minimum replication factor, re-replication occurs after the timeout specified in the `cldb.fs.mark.rereplicate.sec` parameter. This timeout is the time given for a down node to come back online. After this timeout period, the CLDB takes action to restore the replication factor. When enabled, the CLDB manages the namespace container replication separate from the data container replication. This capability is used when you have low volume replication but want to have higher namespace replication. \n\nNote: This parameter must be the same or larger than the equivalent data replication parameter, `replication`.\n\n For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "The path at which to mount the volume.", 
            "type": "string"
          }, 
          {
            "name": "quota", 
            "in": "query", 
            "description": "The quota for the volume as `integer` plus `unit. Example: quota=500G; Units:` `B`, `K`, `M`, `G`, `T`, `P` \n\n \n\nDo not use two-letter abbreviations for quota units, such as `GB` and `MB`.", 
            "type": "string"
          }, 
          {
            "name": "readAce", 
            "in": "query", 
            "description": "Specifies [Access Control Expressions](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions) (ACEs) that grants permissions at the volume level to read files and tables in the volume. The default value is `p`, which grants access to all users.\n\n \n\nNote: An ACE (up to 2KB in length) is a combination of users, groups, and/or roles for whom access (to volume data) is defined using boolean expressions and subexpressions within single quotes. There will be no change to access types that are not passed in with the command.", 
            "type": "string"
          }, 
          {
            "name": "readonly", 
            "in": "query", 
            "description": "Specifies whether or not the volume is read-only:\n\n \n \n*  `0` = Volume is read/write. \n*  `1` = Volume is read-only.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "replication", 
            "in": "query", 
            "description": "The desired replication level. Default: 3 When the number of copies falls below the desired replication factor, but remains equal to or above the minimum replication factor, re-replication occurs after the timeout specified in the `cldb.fs.mark.rereplicate.sec` parameter. Note that this timeout is the time given for a down node to come back online. After this timeout period, the CLDB takes action to restore the replication factor.\n\n \n\nNote: For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "replicationtype", 
            "in": "query", 
            "description": "The desired replication type. You can specify `low_latency` (star replication) or `high_throughput` (chain replication). The default setting is `high_throughput`.", 
            "type": "string", 
            "enum": [
              "low_latency", 
              "high_throughput"
            ]
          }, 
          {
            "name": "rereplicationtimeoutsec", 
            "in": "query", 
            "description": "Timeout (in seconds) before attempting re-replication of replica containers. This volume property defines the timeout period until CLDB starts re-replicating the containers on the node of the volume when CLDB stops receiving a heartbeat from the node.\n\n \n\nWhen a node is down, CLDB gives the node an hour to come back online before it takes any action for the containers on this node. This parameter can be set on volumes to reduce the default 1 hour to a shorter time period. This option is provided mainly for local volumes, repl=1 so that when an mfs is down, CLDB can give up quickly and decide that the container has no master. This forces the TT to give up on local containers and take appropriate recovery action of deleting the mapred volume and creating another one.", 
            "type": "string"
          }, 
          {
            "name": "rootdirperms", 
            "in": "query", 
            "description": "Permissions on the volume root directory.", 
            "type": "string"
          }, 
          {
            "name": "schedule", 
            "in": "query", 
            "description": "The ID of a schedule. Use the [schedule list](http://maprdocs.mapr.com/home/ReferenceGuide/schedule-list.html#schedulelist) command to find the ID of the named schedule you want to apply to the volume.\n\n \n\nIn 4.0.1, if a schedule ID is provided, it applies to a mirror volume. The mirror volume will automatically sync with its source volume on the specified schedule. Use the schedule list command to find the ID of the named schedule you wish to apply to the volume.\n\n \n\nIn 4.0.2 and later releases, if a schedule ID is provided, it applies to either a mirror volume or a standard volume. A standard volume will automatically create snapshots on the specified schedule. A mirror volume will sync with its source volume on the specified schedule. If a mirror volume is made into a standard volume, the `-schedule` option is used as the snapshot schedule for the standard volume.", 
            "type": "string"
          }, 
          {
            "name": "source", 
            "in": "query", 
            "description": "For mirror volumes, the source volume to mirror, in the format `<source volume>@<cluster>` (Required when creating a mirror volume).", 
            "type": "string"
          }, 
          {
            "name": "topology", 
            "in": "query", 
            "description": "The rack path to the volume.\n\n \n\nNote: To create a volume in a specific topology, you must have the [Converged Enterprise Edition](http://maprdocs.mapr.com/home/UpgradeGuide/License-upgrade.html#license-upgrade) installed on your system. Without the Converged Enterprise Edition, when you run the `maprcli volume create` command with the `-topology` option, the following error message is returned: \n\n```\nERROR (10010) -  Volume Creation Failed: Setting topology on a \nvolume requires data placement feature. License not found for \ndata placement.\n```", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The type of volume to create.\n\n \n\nFor 4.0.2 and later releases, these values are accepted:\n\n \n \n* mirror - standard mirror (read-only) volume (promotable to standard read-write volume) \n* rw - standard (read-write) volume (convertible to standard mirror volume) \n* 0 - standard (read-write) volume (for backward compatibility) \n* 1 - non-convertible mirror (read-only) volume (for backward compatibility) \n\n \n\nFor 4.0.1 and earlier releases, these values are accepted:\n\n \n \n* 0 - standard (read-write) volume (this volume is non-convertible) \n* 1 - standard mirror (read-only) volume (this volume is non-convertible)", 
            "type": "string", 
            "enum": [
              "rw", 
              "mirror"
            ]
          }, 
          {
            "name": "user", 
            "in": "query", 
            "description": "Space-separated list of `user:permission` pairs.", 
            "type": "string"
          }, 
          {
            "name": "writeaAce", 
            "in": "query", 
            "description": "Specifies [Access Control Expressions](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions) (ACEs) that grants permission at the volume level to write to files and tables in the volume. The default value is `p`, which grants access to all users.\n\n \n\nNote: An ACE (up to 2KB in length) is a combination of users, groups, and/or roles for whom access (to volume data) is defined using boolean expressions and subexpressions within single quotes.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/fixmountpath": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Corrects the mount path of a volume. Permissions required: fc or m on the volume.", 
        "description": "The CLDB maintains information about the mount path of every volume. If a directory in a volume's path is renamed (by a `hadoop fs` command, for example) the information in the CLDB will be out of date. The `volume fixmountpath` command does a reverse path walk from the volume and corrects the mount path information in the CLDB.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-fixmountpath.html"
        }, 
        "parameters": [
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume name.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster name", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/info": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Displays information about the specified volume. For best results, use the -json option when running the command.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-info.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of fields to return in the query. See the Fields table on the volume command page. Default: all", 
            "type": "array", 
            "items": {
              "type": "string", 
              "enum": [
                "accesstime", 
                "actualreplication", 
                "advisoryquota", 
                "AdvisoryQuotaExceededAlarm", 
                "aename", 
                "aetype", 
                "allowGrant", 
                "AlmostFullTopologyAlarm", 
                "audited", 
                "auditVolume", 
                "CannotMirrorAlarm", 
                "coalesceInterval", 
                "ContainersNonLocalAlarm", 
                "creator", 
                "creatorcontainerid", 
                "creatorvolumeuuid", 
                "DataUnavailableAlarm", 
                "DataUnderReplicatedAlarm", 
                "dbrepllagsecalarmthresh", 
                "disableddataauditoperations", 
                "enableddataauditoperations", 
                "fixCreatorId", 
                "FullTopologyAlarm", 
                "InodesExceededAlarm", 
                "LargeRowWarning", 
                "lastSuccessfulMirrorTime", 
                "limitspread", 
                "localpath", 
                "logicalUsed", 
                "maxinodesalarmthreshold", 
                "minreplicas", 
                "mirrorDataSrcCluster", 
                "mirrorDataSrcVolume", 
                "mirrorDataSrcVolumeId", 
                "MirrorFailureAlarm", 
                "mirrorId", 
                "mirror-percent-complete", 
                "mirrorscheduleid", 
                "mirrorSrcCluster", 
                "mirrorSrcVolume", 
                "mirrorSrcVolumeId", 
                "mirrorstatus", 
                "mirrorthrottle", 
                "mirrortype", 
                "mountdir", 
                "mounted", 
                "nameContainerSizeMB", 
                "nsMinReplicas", 
                "nsNumReplicas", 
                "needsGfsck", 
                "nextMirrorId", 
                "NoNodesInTopologyAlarm", 
                "numcontainers", 
                "numreplicas", 
                "partlyOutOfTopology", 
                "quota", 
                "QuotaExceededAlarm", 
                "rackpath", 
                "readonly", 
                "replicationtype", 
                "ReplTypeConversionInProgress", 
                "reReplTimeOutSec", 
                "scheduleid", 
                "schedulename", 
                "snapshotcount", 
                "SnapshotFailureAlarm", 
                "snapshotused", 
                "TableReplicationAsyncAlarm", 
                "TableReplicationErrorAlarm", 
                "TableReplicationLagHighAlarm", 
                "totalused", 
                "used", 
                "volumeid", 
                "volumename", 
                "volumetype"
              ]
            }, 
            "collectionFormat": "csv"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume name for which to retrieve information. Note: When issuing `maprcli volume info -columns` and `marcli volume list -columns` commands, the column for the volume name is `volumename`.", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Whether the output should be terse or verbose. Default: verbose", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "The mount path of the volume for which to retrieve information.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/link/create": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Creates a link to a volume. Permissions required: fc or m on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-link-create.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The `-path` parameter specifies the link path: `/link` \n\n \n\nExample: `/home/abc/.rw`", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "The volume type: `writeable` or `mirror`.", 
            "required": true, 
            "type": "string", 
            "enum": [
              "writeable", 
              "mirror"
            ]
          }, 
          {
            "name": "volume", 
            "in": "query", 
            "description": "The volume name.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster name.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/link/remove": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Removes the specified symbolic link. Permissions required: fc or m on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-link-remove.html"
        }, 
        "parameters": [
          {
            "name": "path", 
            "in": "query", 
            "description": "The symbolic link to remove. The path parameter specifies the link path and other information about the symbolic link, using the following syntax: `/link/[maprfs::][volume::]<volume type>::<volume name>` \n\n \n \n*  `link` - the symbolic link path *`maprfs` - a keyword to indicate a special MapR-FS link \n*  `volume` - a keyword to indicate a link to a volume \n*  `volume type` - `writeable` or `mirror`  \n*  `volume name` - the name of the volume Example: `/abc/maprfs::mirror::abc`", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster name.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/list": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Lists information about volumes specified by name, path, or filter.", 
        "description": "See the Fields table on the [volume](http://maprdocs.mapr.com/home/ReferenceGuide/volume.html#volume) page for the fields available to filter. See the [Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) for more information.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-list.html"
        }, 
        "parameters": [
          {
            "name": "alarmedvolumes", 
            "in": "query", 
            "description": "Specifies whether (1) or not (0) to list alarmed volumes only. Default: 0", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster name on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of fields to return in the query. See the Fields table on the volume page. Note: When issuing `maprcli volume info -columns` and `marcli volume list -columns` commands, the column for the volume name is `volumename`.", 
            "type": "array", 
            "items": {
              "type": "string", 
              "enum": [
                "accesstime", 
                "actualreplication", 
                "advisoryquota", 
                "AdvisoryQuotaExceededAlarm", 
                "aename", 
                "aetype", 
                "allowGrant", 
                "AlmostFullTopologyAlarm", 
                "audited", 
                "auditVolume", 
                "CannotMirrorAlarm", 
                "coalesceInterval", 
                "ContainersNonLocalAlarm", 
                "creator", 
                "creatorcontainerid", 
                "creatorvolumeuuid", 
                "DataUnavailableAlarm", 
                "DataUnderReplicatedAlarm", 
                "dbrepllagsecalarmthresh", 
                "disableddataauditoperations", 
                "enableddataauditoperations", 
                "fixCreatorId", 
                "FullTopologyAlarm", 
                "InodesExceededAlarm", 
                "LargeRowWarning", 
                "lastSuccessfulMirrorTime", 
                "limitspread", 
                "localpath", 
                "logicalUsed", 
                "maxinodesalarmthreshold", 
                "minreplicas", 
                "mirrorDataSrcCluster", 
                "mirrorDataSrcVolume", 
                "mirrorDataSrcVolumeId", 
                "MirrorFailureAlarm", 
                "mirrorId", 
                "mirror-percent-complete", 
                "mirrorscheduleid", 
                "mirrorSrcCluster", 
                "mirrorSrcVolume", 
                "mirrorSrcVolumeId", 
                "mirrorstatus", 
                "mirrorthrottle", 
                "mirrortype", 
                "mountdir", 
                "mounted", 
                "nameContainerSizeMB", 
                "nsMinReplicas", 
                "nsNumReplicas", 
                "needsGfsck", 
                "nextMirrorId", 
                "NoNodesInTopologyAlarm", 
                "numcontainers", 
                "numreplicas", 
                "partlyOutOfTopology", 
                "quota", 
                "QuotaExceededAlarm", 
                "rackpath", 
                "readonly", 
                "replicationtype", 
                "ReplTypeConversionInProgress", 
                "reReplTimeOutSec", 
                "scheduleid", 
                "schedulename", 
                "snapshotcount", 
                "SnapshotFailureAlarm", 
                "snapshotused", 
                "TableReplicationAsyncAlarm", 
                "TableReplicationErrorAlarm", 
                "TableReplicationLagHighAlarm", 
                "totalused", 
                "used", 
                "volumeid", 
                "volumename", 
                "volumetype"
              ]
            }, 
            "collectionFormat": "csv"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying volumes to list. See [Filters](http://maprdocs.mapr.com/home/ReferenceGuide/maprcli-REST-API-Syntax-Filters.html#concept_znz_qxz_5t) for more information. Default: none", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of rows to return, beginning at start. Default: 2147483647", 
            "type": "string"
          }, 
          {
            "name": "nodes", 
            "in": "query", 
            "description": "A list of nodes. If specified, `volume list` only lists volumes on the specified nodes.", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Specifies whether the output should be `terse` or `verbose`. Default: verbose", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The offset from the starting row according to sort. Default: 0", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/mirror/start": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Starts mirroring on the specified volume from its source volume.", 
        "description": "* License required: Enterprise Edition \n* Permissions required: `fc` or `restore` on the volume \n\n \n\n When a mirror is started, the mirror volume is synchronized from a hidden internal snapshot so that the mirroring process is not affected by any concurrent changes to the source volume. The `volume mirror start` command does not wait for mirror completion, but returns immediately. The changes to the mirror volume occur atomically at the end of the mirroring process; deltas transmitted from the source volume do not appear until mirroring is complete.\n\n \n\nTo provide rollback capability for the mirror volume, the mirroring process creates a snapshot of the mirror volume before starting the mirror, with the following naming format: `<volume>.mirrorsnap.<date>.<time>`.\n\n \n\nNormally, the mirroring operation transfers only deltas from the last successful mirror. Under certain conditions (mirroring a volume repaired by `fsck`, for example), the source and mirror volumes can become out of sync. In such cases, it is impossible to transfer deltas, because the state is not the same for both volumes. Use the `-full` option to force the mirroring operation to transfer all data to bring the volumes back in sync.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-mirror-start.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "full", 
            "in": "query", 
            "description": "Specifies whether to perform a full copy of all data. If false, only the deltas are copied.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume for which to start the mirror.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/mirror/stop": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Stops mirroring on the specified volume.", 
        "description": "* License required: Enterprise Edition \n* Permissions required: `fc` or `restore` on the volume \n\n \n\n The `volume mirror stop` command lets you stop mirroring (for example, during a network outage). You can use the `volume mirror start` command to resume mirroring.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-mirror-stop.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume for which to stop the mirror.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/modify": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Modifies an existing volume. Permissions required: m or fc on the volume.", 
        "description": "An error occurs if the name or path refers to a non-existent volume, or cannot be resolved.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-modify.html"
        }, 
        "parameters": [
          {
            "name": "advisoryquota", 
            "in": "query", 
            "description": "The advisory quota for the volume as `integer` plus `unit. Example: quota=500G; Units:` `B`, `K`, `M`, `G`, `T`, `P`", 
            "type": "string"
          }, 
          {
            "name": "ae", 
            "in": "query", 
            "description": "The accounting entity that owns the volume.", 
            "type": "string"
          }, 
          {
            "name": "aetype", 
            "in": "query", 
            "description": "The type of accounting entity:\n\n \n \n*  `0`=`user`  \n*  `1`=`group`", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "allowgrant", 
            "in": "query", 
            "description": "Specifies whether the volume as a parent grants permission for a child volume to inherit its properties. True or false. Default: false.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "auditenabled", 
            "in": "query", 
            "description": "Specifies whether to turn auditing on for the volume. If auditing is also enabled at the cluster level with the  [`maprcli audit data`](http://maprdocs.mapr.com/home/ReferenceGuide/audit-data.html)  command, setting this value to `true` causes auditing to start for any directories, files, or tables that are already enabled for auditing. If none are yet so enabled, enabling auditing on any of them causes auditing of them to start.\n\n \n\nYou must have the `fc` permission on the cluster to use this parameter. See [ `acl` ](http://maprdocs.mapr.com/home/ReferenceGuide/acl.html) for details about this permission.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "coalesce", 
            "in": "query", 
            "description": "The interval of time during which READ, WRITE, or GETATTR operations on one file from one client IP address are logged only once, if auditing is enabled.\n\n \n\nFor example, suppose that a client application reads a single file three times in 6 minutes, so that there is one read at 0 minutes, another at 3 minutes, and a final read at 6 minutes. If the coalesce interval is at least 6 minutes, then only the first read operation is logged. However, if the interval is between 4 minutes, then only the first and third read operations are logged. If the interval is 2 minutes, all three read operations are logged.\n\n \n\nThe default value is 60 minutes. Setting this field to a larger number helps prevent audit logs from growing quickly.", 
            "type": "string"
          }, 
          {
            "name": "dataauditops", 
            "in": "query", 
            "description": "The comma separated list of filesystem operations to include (specified with a preceding plus sign (`+`)) or exclude (specified with a preceding minus sign (`-`)) from auditing. \n\n \n\nNote: If the first operation in the list (of operations) is to be excluded from auditing, it must be preceded by two minus (`--`) signs. Subsequent operations to exclude must be preceded by only a single minus (`-`) sign, whether or not the first operation was included (using a plus (`+`) sign) or excluded (using two minus (`--`) signs). If neither sign is specified, the given operation is included for auditing.\n\n \n\nThe operations that can be included (`+`) or excluded (`-`) from auditing are listed [here](http://maprdocs.mapr.com/home/SecurityGuide/Auditing-FilesystemTableOperations.html#AuditingofFilesystemOperationsandTableOperations). You can, alternatively, group all the operations using the keyword `all`, which: \n \n* If included (`+`), cannot be specified with a list of other included operations. \n* If excluded (`-`), cannot be specified with a list of other excluded operations. \n\n \n\n \n\nYou can specify a mixed list of included and excluded operations. There will be no change to operations that are not specified with the command.\n\n \n\nTip: For more information, see [Selective Auditing of Filesystem and Table Operations](http://maprdocs.mapr.com/home/SecurityGuide/SelectiveAuditingOfOperations.html#concept_nzd_j5g_h5).", 
            "type": "string"
          }, 
          {
            "name": "group", 
            "in": "query", 
            "description": "Space-separated list of `group:permission` pairs.", 
            "type": "string"
          }, 
          {
            "name": "minreplication", 
            "in": "query", 
            "description": "The minimum replication level. Default: 0. \n\nTip: For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "mirrorschedule", 
            "in": "query", 
            "description": "The schedule ID corresponding to the schedule to be used for mirroring. Pre-assigned IDs include 1 for critical data, 2 for important data, and 3 for normal data. Custom schedules are assigned ID numbers in sequence. To determine the ID number, use the `schedule list` command.", 
            "type": "string"
          }, 
          {
            "name": "mirrorthrottle", 
            "in": "query", 
            "description": "Specifies whether mirror throttling is enabled (`true`) or disabled (`false`). The default is `true`. Throttling is set on the source volume and applies to all its mirrors.", 
            "type": "boolean", 
            "enum": [
              "true", 
              "false"
            ]
          }, 
          {
            "name": "nsminreplication", 
            "in": "query", 
            "description": "The minimum replication level for the namespace container. Default: 2 When the replication factor falls below this minimum, re-replication occurs as aggressively as possible to restore the replication level. If any containers in the CLDB volume fall below the minimum replication factor, writes are disabled until aggressive re-replication restores the minimum level of replication. When enabled, the CLDB manages the namespace container replication separate from the data container replication. This capability is used when you have low volume replication but want to have higher namespace replication. \n\nNote: This parameter must be the same or larger than the equivalent data replication parameter, `minreplication`.\n\n For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "nsreplication", 
            "in": "query", 
            "description": "The desired namespace container replication level. Default: 3. When the number of copies falls below the desired replication factor, but remains equal to or above the minimum replication factor, re-replication occurs after the timeout specified in the `cldb.fs.mark.rereplicate.sec` parameter. This timeout is the time given for a down node to come back online. After this timeout period, the CLDB takes action to restore the replication factor. When enabled, the CLDB manages the namespace container replication separate from the data container replication. This capability is used when you have low volume replication but want to have higher namespace replication. \n\nNote: This parameter must be the same or larger than the equivalent data replication parameter, `replication`.\n\n For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the volume to modify.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "quota", 
            "in": "query", 
            "description": "The quota for the volume as `integer` plus `unit. Example: quota=500G; Units:` `B`, `K`, `M`, `G`, `T`, `P` \n\n \n\nNote that quotas for source and mirror volumes must match.", 
            "type": "string"
          }, 
          {
            "name": "readAce", 
            "in": "query", 
            "description": "Specifies [Access Control Expressions](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions) (ACEs) that grants permissions at the volume level to read files and tables in the volume. The default value is `p`, which grants access to all users.\n\n \n\nNote: An ACE (up to 2KB in length) is a combination of users, groups, and/or roles for whom access (to volume data) is defined using boolean expressions and subexpressions within single quotes. When you pass in an access type that has already been set, the new value will replace the existing value for that access type. There will be no change to access types that are not passed in with the command, whether or not they were set.", 
            "type": "string"
          }, 
          {
            "name": "readonly", 
            "in": "query", 
            "description": "Specifies whether the volume is read-only. \n\n \n \n*  `0` = read/write \n*  `1` = read-only", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "replication", 
            "in": "query", 
            "description": "The desired replication level. Default: 0.\n\n \n\nTip: For more information, see [Determining Replication Factor](http://maprdocs.mapr.com/home/AdministratorGuide/DetermineVolReplicationFactor.html).", 
            "type": "string"
          }, 
          {
            "name": "rereplicationtimeoutsec", 
            "in": "query", 
            "description": "Timeout (in seconds) before attempting re-replication of replica containers. This volume property defines the timeout period until CLDB starts re-replicating the containers on the node of the volume when CLDB stops receiving a heartbeat from the node.\n\n \n\nWhen a node is down, CLDB gives the node an hour to come back online before it takes any action for the containers on this node. This parameter can be set on volumes to reduce the default 1 hour to a shorter time period. This option is provided mainly for local volumes, repl=1 so that when an mfs is down, CLDB can give up quickly and decide that the container has no master. This forces the TT to give up on local containers and take appropriate recovery action of deleting the mapred volume and creating another one.", 
            "type": "string"
          }, 
          {
            "name": "schedule", 
            "in": "query", 
            "description": "A schedule ID. If a schedule ID is provided, then the volume will automatically create snapshots (normal volume) or sync with its source volume (mirror volume) on the specified schedule.", 
            "type": "string"
          }, 
          {
            "name": "source", 
            "in": "query", 
            "description": "(Mirror volumes only) The source volume from which a mirror volume receives updates, specified in the format `<volume>@<cluster>`.", 
            "type": "string"
          }, 
          {
            "name": "user", 
            "in": "query", 
            "description": "Space-separated list of `user:permission` pairs.", 
            "type": "string"
          }, 
          {
            "name": "threshold", 
            "in": "query", 
            "description": "Threshold for the [ INODES_EXCEEDED](http://maprdocs.mapr.com/home/ReferenceGuide/VolumeAlarms.html) alarm.", 
            "type": "string"
          }, 
          {
            "name": "type", 
            "in": "query", 
            "description": "If type = mirror, the volume is converted from a rw volume to a mirror volume.\n\n \n\nIf type = rw, the volume is converted from a mirror volume to a rw volume.", 
            "type": "string", 
            "enum": [
              "rw", 
              "mirror"
            ]
          }, 
          {
            "name": "writeAce", 
            "in": "query", 
            "description": "Specifies [Access Control Expressions](http://maprdocs.mapr.com/home/SecurityGuide/SyntaxOfACE.html#SyntaxofAccessControlExpressions) (ACEs) that grants permission at the volume level to write to files and tables in the volume. The default value is `p`, which grants access to all users.\n\n \n\nNote: An ACE (up to 2KB in length) is a combination of users, groups, and/or roles for whom access is defined using boolean expressions and subexpressions within single quotes. When you pass in an access type that has already been set, the new value will replace the existing value for that access type. There will be no change to access types that are not passed in with the command, whether or not they were set.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/mount": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Mounts one or more specified volumes. Permissions required: fc or m on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-mount.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the volume to mount.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "The path at which to mount the volume.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "createparent", 
            "in": "query", 
            "description": "Specifies whether or not to create a parent volume:\n\n \n \n*  `0` = Do not create a parent volume. \n*  `1` = Create a parent volume.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/move": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Moves the specified volume or mirror to a different topology. Permissions required: m or fc on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-move.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume name.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "topology", 
            "in": "query", 
            "description": "The new rack path to the volume.\n\n \n\nNote: To move the volume to another topology, you must have the [Converged Enterprise Edition](http://maprdocs.mapr.com/home/UpgradeGuide/License-upgrade.html#license-upgrade) installed on your system. Without the Converged Enterprise Edition, when you run the `maprcli volume move` command with the `-topology` option to move the volume to another topology, the following error message is returned: \n\n```\nERROR (10010) - Volume Move: No license for requested operation\n```", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/remove": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Removes the specified volume or mirror. Permissions required: d or fc on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-remove.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "force", 
            "in": "query", 
            "description": "Forces the removal of the volume, even if it would otherwise be prevented.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume name.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "All volumes with names that match the filter are removed.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/rename": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Renames the specified volume or mirror. Permissions required: fc or d on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-rename.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume name.", 
            "required": true, 
            "type": "string"
          }, 
          {
            "name": "newname", 
            "in": "query", 
            "description": "The new volume name.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/showmounts": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Returns a list of mount points for the specified volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-showmounts.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The name of the cluster hosting the volume.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the volume to return a list of mount points for.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/snapshot/create": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Creates a snapshot of the specified volume, using the specified snapshot name.", 
        "description": "* License required: Enterprise Edition \n* Permissions required: `fc` or `m` on the volume", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-snapshot-create.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "snapshotname", 
            "in": "query", 
            "description": "The name of the snapshot to create.", 
            "type": "string"
          }, 
          {
            "name": "volume", 
            "in": "query", 
            "description": "The volume for which to create a snapshot.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/snapshot/list": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Displays info about a set of snapshots.", 
        "description": "You can specify the snapshots by volumes or paths, or by specifying a filter to select volumes with certain characteristics.", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-snapshot-list.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "columns", 
            "in": "query", 
            "description": "A comma-separated list of fields to return in the query. See the Fields table below. Default: none", 
            "type": "array", 
            "items": {
              "type": "string", 
              "enum": [
                "snapshotid", 
                "snapshotname", 
                "volumeid", 
                "volumename", 
                "volumepath", 
                "ownername", 
                "ownertype", 
                "cumulativeReclaimSizeMB", 
                "creationtime", 
                "expirytime", 
                "volumeSnapshotAces"
              ]
            }, 
            "collectionFormat": "csv"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying snapshots to preserve. See Filters for more information.", 
            "type": "string"
          }, 
          {
            "name": "limit", 
            "in": "query", 
            "description": "The number of rows to return, beginning at start. Default: 0", 
            "type": "string"
          }, 
          {
            "name": "output", 
            "in": "query", 
            "description": "Specifies whether the output should be `terse` or `verbose`. Default: `verbose`", 
            "type": "string", 
            "enum": [
              "terse", 
              "verbose"
            ]
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "A comma-separated list of paths for which to preserve snapshots.", 
            "type": "string"
          }, 
          {
            "name": "start", 
            "in": "query", 
            "description": "The offset from the starting row according to sort. Default: 0", 
            "type": "string"
          }, 
          {
            "name": "volume", 
            "in": "query", 
            "description": "A comma-separated list of volumes for which to preserve snapshots.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/snapshot/preserve": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Preserves one or more snapshots from expiration.", 
        "description": "Specify the snapshots by volumes, paths, filter, or IDs.\n\n \n \n* License required: Enterprise Edition \n* Permissions required: `fc `or `m` on the volume", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-snapshot-preserve.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "filter", 
            "in": "query", 
            "description": "A filter specifying snapshots to preserve. See Filters for more information.", 
            "type": "string"
          }, 
          {
            "name": "path", 
            "in": "query", 
            "description": "A comma-separated list of paths for which to preserve snapshots.", 
            "type": "string"
          }, 
          {
            "name": "snapshots", 
            "in": "query", 
            "description": "A comma-separated list of snapshot IDs to preserve.", 
            "type": "string"
          }, 
          {
            "name": "volume", 
            "in": "query", 
            "description": "A comma-separated list of volumes for which to preserve snapshots.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/snapshot/remove": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Removes one or more snapshots.", 
        "description": "* License required: Enterprise Edition \n* Permissions required: `fc` or `m` on the volume", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-snapshot-remove.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "snapshotname", 
            "in": "query", 
            "description": "The name of the snapshot to remove.", 
            "type": "string"
          }, 
          {
            "name": "snapshots", 
            "in": "query", 
            "description": "A comma-separated list of IDs of snapshots to remove.", 
            "type": "string"
          }, 
          {
            "name": "volume", 
            "in": "query", 
            "description": "The name of the volume from which to remove the snapshot.", 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/unmount": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Unmounts one or more mounted volumes. Permissions required: fc or m on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-unmount.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "force", 
            "in": "query", 
            "description": "Specifies whether (1) or not (0) to force the volume to unmount.", 
            "type": "string", 
            "enum": [
              "0", 
              "1"
            ]
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The name of the volume to unmount.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }, 
    "/volume/upgradeformat": {
      "get": {
        "tags": [
          "volume"
        ], 
        "summary": "Upgrades and old-type volume to a new-type volume, which can in turn be used as a promotable mirror volume. Permissions required: m or fc on the volume.", 
        "description": "", 
        "externalDocs": {
          "url": "http://maprdocs.mapr.com/home/ReferenceGuide/volume-upgradeformat.html"
        }, 
        "parameters": [
          {
            "name": "cluster", 
            "in": "query", 
            "description": "The cluster on which to run the command.", 
            "type": "string"
          }, 
          {
            "name": "name", 
            "in": "query", 
            "description": "The volume name.", 
            "required": true, 
            "type": "string"
          }
        ], 
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  }, 
  "securityDefinitions": {
    "basic_auth": {
      "type": "basic"
    }
  }, 
  "security": [
    {
      "basic_auth": []
    }
  ]
}