Order history in date accending order (earliest first).
Room access setting. Valid values are: public, private (default: public)
SQL to run after a successful action. Limited to specific actions at this time.
For some actions using the file parameter, append will append output to the existing file.
Archive the room.
Automatically attempt to split messages that exceed HipChat's maximum message length. Messages with lines within the length limit qualify for auto splitting.
HipChat limits the rate of requests it will handle in a period of time. Use this switch to automatically handle rate limit failures and retry. The action may take a few minutes to complete. Do not use this switch in performance critical contexts like JIRA post functions or Confluence renderings.
Regular expression for determining the start of a block of lines for sendMessagesFromFile. A line matching this regex will indicate the end of a previous block and the start of a new block of lines. A special value of @log will provide standard handling of Atlassian default style log files including exceptions.
For run actions, this option will automatically clear an existing file on the first append requested.
Background color of a message. Default is yellow.
Background colour of a message. Default is yellow.
Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored.
Common parameter string added to all run actions.
Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.
Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions.
Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs.
Database name is required for SQL actions.
Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format.
Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.
Database table needs to be created before adding rows.
By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar
Database user password. Defaults to password.
Database table name when creating or updating a database from list output.
Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.
Database user name. Defaults to user.
Requests detail debug output. Optional for all actions.
Disallow access to the room by non-users.
JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.
User email. Email can be used to uniquely identify a user.
Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.
Latest date for history entries. Default to now.
Regular expression for determining if a individual line should be excluded when using sendMessagesFromFile. This excludes any matching line from being sent whether it is part of a block or not. It has no impact on block determination, other block lines will not be excluded. Exclude takes precendence over include filtering.
Path to file based content or result output. Use - for standard input.
Name of file when shared. Defaults to the name of the file represented by the file parameter.
Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.
Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled.
Allow access to the room by non-users via a guest URL.
Prints this help message.
Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.
Include archived rooms in the list.
Include deleted users in the list.
Include guests in the list.
Include users with offline status in the list.
Include private rooms in the list.
Set user to be an administrator.
Set user to not be an administrator. Default for created users.
Maximum number of entries to return. (default: 2147483647)
An absolute link to share.
Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.
Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.
Mention name for a user.
A text (default) or html message. Message length is limited to 10000 characters.
Format of the message. Valid values are: text, html. Default is text.
File mime type if you want to override automatic determination by file extension.
Entity name. In most cases, an entity's numeric id can be a substitute for a name. Example: user, room, or emoticon name. Room and user names are restricted to 50 characters or less.
New email address for updating a user.
New mention name for updating a user.
New entity name for an update.
Whether a message should trigger a user notification respecting recipient's notification preferences.
Comma separated list of support, experimental, or other client or action specific options.
Specify output format for an action. (default: 1)
Room owner by name or id.
Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.
Property file with database parameters, field mappings, or client specific information.
Limit some output messages. Optional for all actions.
Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement key.
Regular expression for including matching content. For example, used to subset lists of rooms.
Replace existing entity on add, create, or similar actions.
Replacement string when matching content with a regular expression. Use $1 and similar for capture groups.
URL fragment for a request.
URL request parameters or post data.
Room name or id.
Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.
Simulate running actions. Log the action that would be taken.
Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.
SQL select statement used to generate a run script.
Earliest date to get history data. Default is recent to get the most recent 75 entries.
User timeZone. See https://bobswift.atlassian.net/wiki/x/noIbBg
Seconds to wait looking for lines to be appended to a file. Use -1 for infinite wait. (default: 0)
Job title for a user.
Authentication token for remote access. Obtain the 40 character token by logging in to HipChat and going to 'Account Settings' then 'API access'.
Emoticon type. Valid values are: all, global, group. Default is all.
Unarchive the room.
Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.
User password for user management actions.
Requests verbose output to help with problem determination. Optional for all actions.