{ "name": "st2", "description": "CLI for StackStorm event-driven automation platform", "options": [ { "names": [ "--help", "-h" ], "description": "Show this help message and exit", "priority": 60 }, { "names": [ "--version" ], "description": "Show program's version number and exit" }, { "names": [ "--url" ], "description": "Base URL for the API servers. Assumes all servers use the same base URL and default ports are used. Get ST2_BASE_URL from the environment variables by default", "args": [ { "name": "BASE_URL" } ] }, { "names": [ "--auth-url" ], "description": "URL for the authentication service. Get ST2_AUTH_URL from the environment variables by default", "args": [ { "name": "AUTH_URL" } ] }, { "names": [ "--api-url" ], "description": "URL for the API server. Get ST2_API_URL from the environment variables by default", "args": [ { "name": "API_URL" } ] }, { "names": [ "--stream-url" ], "description": "URL for the stream endpoint. Get ST2_STREAM_URLfrom the environment variables by default", "args": [ { "name": "ST2_STREAM_URL" } ] }, { "names": [ "--api-version" ], "description": "API version to use. Get ST2_API_VERSION from the environment variables by default", "args": [ { "name": "API_VERSION" } ] }, { "names": [ "--cacert" ], "description": "Path to the CA cert bundle for the SSL endpoints. Get ST2_CACERT from the environment variables by default. If this is not provided, then SSL cert will not be verified", "args": [ { "name": "CACERT" } ] }, { "names": [ "--config-file" ], "description": "Path to the CLI config file", "args": [ { "name": "CONFIG_FILE" } ] }, { "names": [ "--print-config" ], "description": "Parse the config file and print the values" }, { "names": [ "--skip-config" ], "description": "Don't parse and use the CLI config file" }, { "names": [ "--debug" ], "description": "Enable debug mode" } ], "subcommands": [ { "name": "run", "description": "Invoke an action manually", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "--delay" ], "description": "How long (in milliseconds) to delay the execution before scheduling", "args": [ { "name": "DELAY" } ] }, { "names": [ "--tail" ], "description": "Automatically start tailing new execution" }, { "names": [ "--auto-dict" ], "description": "Automatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)" }, { "names": [ "--trace-tag", "--trace_tag" ], "description": "A trace tag string to track execution later", "args": [ { "name": "TRACE_TAG" } ] }, { "names": [ "--trace-id" ], "description": "Existing trace id for this execution", "args": [ { "name": "TRACE_ID" } ] }, { "names": [ "-a", "--async" ], "description": "Do not wait for action to finish" }, { "names": [ "-e", "--inherit-env" ], "description": "Pass all the environment variables which are accessible to the CLI as 'env' parameter to the action. Note: Only works with python, local and remote runners" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" }, { "name": "parameters", "description": "List of keyword args, positional args, and optional args for the action", "isVariadic": true } ] }, { "name": "action", "description": "An activity that happens as a response to the external event", "subcommands": [ { "name": "list", "description": "Get the list of actions", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] } ] }, { "name": "get", "description": "Get individual action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID", "isVariadic": true } ] }, { "name": "create", "description": "Create a new action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "update", "description": "Update an existing action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" }, { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete", "description": "Delete an existing action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-r", "--remove-files" ], "description": "Remove action files from disk" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "enable", "description": "Enable an existing action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "disable", "description": "Disable an existing action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "execute", "description": "Invoke an action manually", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "--delay" ], "description": "How long (in milliseconds) to delay the execution before scheduling", "args": [ { "name": "DELAY" } ] }, { "names": [ "--tail" ], "description": "Automatically start tailing new execution" }, { "names": [ "--auto-dict" ], "description": "Automatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)" }, { "names": [ "--trace-tag", "--trace_tag" ], "description": "A trace tag string to track execution later", "args": [ { "name": "TRACE_TAG" } ] }, { "names": [ "--trace-id" ], "description": "Existing trace id for this execution", "args": [ { "name": "TRACE_ID" } ] }, { "names": [ "-a", "--async" ], "description": "Do not wait for action to finish" }, { "names": [ "-e", "--inherit-env" ], "description": "Pass all the environment variables which are accessible to the CLI as 'env' parameter to the action. Note: Only works with python, local and remote runners" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" }, { "name": "parameters", "description": "List of keyword args, positional args, and optional args for the action", "isVariadic": true } ] } ] }, { "name": "action-alias", "description": "Action aliases", "subcommands": [ { "name": "list", "description": "Get the list of action aliases", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] } ] }, { "name": "get", "description": "Get the individual action aliases", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID", "isVariadic": true } ] }, { "name": "create", "description": "Create a new action alias", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "update", "description": "Update an existing action alias", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name-or-id", "description": "Name or ID" }, { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete", "description": "Delete an existing action alias", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name-or-id", "description": "Name or ID" } ] }, { "name": "match", "description": "Get the action alias that match the command text", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ], "args": [ { "name": "comamnd", "description": "Command text" } ] }, { "name": "execute", "description": "Execute the command text by finding a matching action alias", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] } ], "args": [ { "name": "comamnd", "description": "Command text" } ] } ] }, { "name": "auth", "description": "Authenticate user and acquire access token", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-p" ], "description": "Password", "args": [ { "name": "PASSWORD" } ] }, { "names": [ "-l", "--ttl" ], "description": "The life span of the token in seconds. Max TTL configured by the admin supersedes this", "args": [ { "name": "TTL" } ] }, { "names": [ "-t", "--only-token" ], "description": "On successful authentication, print only token to the console" } ], "args": [ { "name": "username", "description": "Name of the user" } ] }, { "name": "login", "description": "Authenticate user, acquire access token, and update CLI config directory", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-p" ], "description": "Password", "args": [ { "name": "PASSWORD" } ] }, { "names": [ "-l", "--ttl" ], "description": "The life span of the token in seconds. Max TTL configured by the admin supersedes this", "args": [ { "name": "TTL" } ] }, { "names": [ "-w", "--write-password" ], "description": "Write the password in plain text to the config file (default is to omit it)" } ], "args": [ { "name": "username", "description": "Name of the user" } ] }, { "name": "whoami", "description": "Display the currently authenticated user", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ] }, { "name": "apikey", "description": "API Keys", "parserDirectives": { "optionsMustPrecedeArgs": true }, "subcommands": [ { "name": "list", "description": "Get the list of api keys", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "--show-secrets" ], "description": "Full list of attributes" } ] }, { "name": "get", "description": "Get individual api key", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "key-or-id", "description": "Key or ID" } ] }, { "name": "create", "description": "Create a new api key", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] }, { "names": [ "-m", "--metadata" ], "description": "Optional metadata to associate with the API Keys", "args": [ { "name": "METADATA" } ] }, { "names": [ "-k", "--only-key" ], "description": "Only print API Key to the console on creation" } ] }, { "name": "delete", "description": "Delete an existing api key", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "key-or-id", "description": "Key or ID" } ] }, { "name": "enable", "description": "Enable an existing api key", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "key-or-id", "description": "Key or ID" } ] }, { "name": "disable", "description": "Disable an existing api key", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "key-or-id", "description": "Key or ID" } ] }, { "name": "load", "description": "Load api key from a file", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] } ] }, { "name": "execution", "description": "An invocation of an action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent action executions", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-n", "--last" ], "description": "List N most recent; use -n -1 to fetch the full result set", "args": [ { "name": "LAST", "suggestions": [ "10", "5", "1", "-1" ] } ] }, { "names": [ "-s", "--sort" ], "description": "Sort action executions by start timestamp, asc|ascending (earliest first) or desc|descending (latest first)", "args": [ { "name": "SORT_ORDER", "suggestions": [ "desc", "descending", "asc", "ascending" ] } ] }, { "names": [ "-tg", "timestamp-gt" ], "description": "Only return executions with timestamp greater than the one provided. Use time in the format '2000-01-01T12:00:00.000Z'", "args": [ { "name": "TIMESTAMP_GT" } ] }, { "names": [ "-tl", "timestamp-lt" ], "description": "Only return executions with timestamp lower than the one provided. Use time in the format '2000-01-01T12:00:00.000Z'", "args": [ { "name": "TIMESTAMP_LT" } ] }, { "names": [ "-l", "--showall" ], "description": "Show all attributes" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "--action" ], "description": "Action reference to filter the list", "args": [ { "name": "ACTION" } ] }, { "names": [ "--status" ], "description": "Only return executions with the provided status. Possible values are 'succeeded', 'running', 'scheduled', 'paused', 'failed', 'canceling' or 'canceled'", "args": [ { "name": "STATUS", "suggestions": [ "succeeded", "running", "scheduled", "paused", "failed", "canceling", "canceled" ] } ] }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] }, { "names": [ "--trigger_instance" ], "description": "Trigger instance id to filter the list", "args": [ { "name": "TRIGGER_INSTANCE" } ] } ] }, { "name": "get", "description": "Get individual action execution", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-x", "--exclude-result" ], "description": "Don't retrieve and display the result field" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "--delay" ], "description": "How long (in milliseconds) to delay the execution before scheduling", "args": [ { "name": "DELAY" } ] }, { "names": [ "--tail" ], "description": "Automatically start tailing new execution" }, { "names": [ "--auto-dict" ], "description": "Automatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)" } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "re-run", "description": "Re-run a particular action", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--tasks" ], "description": "Name of the workflow tasks to re-run", "args": [ { "name": "TASKS", "isVariadic": true } ] }, { "names": [ "--no-reset" ], "description": "Name of the with-items tasks to not reset. This only applies to Orquesta workflows. By default, all iterations for with- items tasks is rerun. If no reset, only failed iterations are rerun", "args": [ { "name": "NO_RESET" } ] }, { "names": [ "-a", "--async" ], "description": "Do not wait for action to finish" }, { "names": [ "-e", "--inherit-env" ], "description": "Pass all the environment variables which are accessible to the CLI as 'env' parameter to the action. Note: Only works with python, local and remote runners" }, { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "--delay" ], "description": "How long (in milliseconds) to delay the execution before scheduling", "args": [ { "name": "DELAY" } ] }, { "names": [ "--tail" ], "description": "Automatically start tailing new execution" }, { "names": [ "--auto-dict" ], "description": "Automatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)" } ], "args": [ { "name": "id", "description": "ID" }, { "name": "parameters", "description": "List of keyword args, positional args, and optional args for the action", "isVariadic": true } ] }, { "name": "cancel", "description": "Cancel action executions", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "pause", "description": "Pause action executions (workflow executions only)", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "--delay" ], "description": "How long (in milliseconds) to delay the execution before scheduling", "args": [ { "name": "DELAY" } ] }, { "names": [ "--tail" ], "description": "Automatically start tailing new execution" }, { "names": [ "--auto-dict" ], "description": "Automatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)" } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "resume", "description": "Resume action executions (workflow executions only)", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "-k", "--key" ], "description": "If result is type of JSON, then print specific key-value pair; dot notation for nested JSON is supported", "args": [ { "name": "KEY" } ] }, { "names": [ "--delay" ], "description": "How long (in milliseconds) to delay the execution before scheduling", "args": [ { "name": "DELAY" } ] }, { "names": [ "--tail" ], "description": "Automatically start tailing new execution" }, { "names": [ "--auto-dict" ], "description": "Automatically convert list items to dictionaries when colons are detected. (NOTE - this parameter and its functionality will be deprecated in the next release in favor of a more robust conversion method)" } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "tail", "description": "Tail output of a particular execution", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--type" ], "description": "Type of output to tail for. If not provided, defaults to all", "args": [ { "name": "OUTPUT_TYPE" } ] }, { "names": [ "--include-metadata" ], "description": "Include metadata (timestamp, output type) with the output" } ], "args": [ { "name": "id", "description": "ID" } ] } ] }, { "name": "inquiry", "description": "Inquiries provide an opportunity to ask a question and wait for a response in a workflow", "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent inquiries", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-n", "--last" ], "description": "List N most recent; use -n -1 to fetch the full result set", "args": [ { "name": "LAST", "suggestions": [ "10", "5", "1", "-1" ] } ] }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] }, { "name": "get", "description": "Get individual inquiry", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "respond", "description": "Respond to an inquiry", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-r", "--response" ], "description": "Entire response payload as JSON string (bypass interactive mode)", "args": [ { "name": "RESPONSE" } ] } ], "args": [ { "name": "id", "description": "ID" } ] } ] }, { "name": "key", "description": "Key value pair is used to store commonly used configuration for reuse in sensors, actions, and rules", "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent key value pairs", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "--prefix" ], "description": "Only return values with names starting with the provided prefix", "args": [ { "name": "PREFIX" } ] }, { "names": [ "-d", "--decrypt" ], "description": "Decrypt secrets and displays plain text" }, { "names": [ "-s", "--scope" ], "description": "Scope item is under. Example: 'user'" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] }, { "names": [ "-n", "--last" ], "description": "List N most recent; use -n -1 to fetch the full result set", "args": [ { "name": "LAST", "suggestions": [ "10", "5", "1", "-1" ] } ] } ] }, { "name": "get", "description": "Get individual key value pair", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--decrypt" ], "description": "Decrypt secrets and displays plain text" }, { "names": [ "-s", "--scope" ], "description": "Scope item is under. Example: 'user'" } ], "args": [ { "name": "name", "description": "Name", "isVariadic": true } ] }, { "name": "delete", "description": "Delete an existing key value pair", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-s", "--scope" ], "description": "Scope item is under. Example: 'user'" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] } ], "args": [ { "name": "name", "description": "Name" } ] }, { "name": "set", "description": "Set an existing key value pair", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-e", "--enrypt" ], "description": "Encrypt values before saving" }, { "names": [ "--enrypted" ], "description": "Value provided is already encrypted with the instance crypto key and should be stored as-is" }, { "names": [ "-l", "--ttl" ], "description": "The life span of the token in seconds. Max TTL configured by the admin supersedes this", "args": [ { "name": "TTL" } ] }, { "names": [ "-s", "--scope" ], "description": "Scope item is under. Example: 'user'" }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] } ], "args": [ { "name": "name", "description": "Name" }, { "name": "value", "description": "Value", "isOptional": true } ] }, { "name": "load", "description": "Load a list of key value pairs from file", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-c", "--convert" ], "description": "Convert non-string types (hash, array, boolean, int, float) to a JSON string before loading it into the datastore" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete_by_prefix", "description": "Delete KeyValue pairs which match the provided prefix", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--prefix" ], "description": "Only return values with names starting with the provided prefix", "args": [ { "name": "PREFIX" } ] } ], "args": [ { "name": "prefix", "description": "Prefix" } ] } ] }, { "name": "pack", "description": "A group of related integration resources: actions, rules, and sensors", "subcommands": [ { "name": "list", "description": "Get the list of packs", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] }, { "name": "get", "description": "Get information about an installed pack", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref", "description": "Reference", "isVariadic": true } ] }, { "name": "show", "description": "Get information about an available pack from the index", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "pack", "description": "Pack" } ] }, { "name": "search", "description": "Search the index for a pack with any attribute matching the query", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ], "args": [ { "name": "query", "description": "Query" } ] }, { "name": "install", "description": "Install new packs", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" }, { "names": [ "force" ], "description": "Force" }, { "names": [ "--skip-dependencies" ], "description": "Skip dependencies" } ], "args": [ { "name": "pack", "description": "Pack", "isVariadic": true } ] }, { "name": "remove", "description": "Remove packs", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-d", "--detail" ], "description": "Display full detail of the execution in table format" } ], "args": [ { "name": "pack", "description": "Pack", "isVariadic": true } ] }, { "name": "register", "description": "Register pack(s): sync all file changes with DB", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--types" ], "description": "Types of content to register", "args": [ { "name": "TYPES", "isVariadic": true } ] } ], "args": [ { "name": "pack", "description": "Pack", "isVariadic": true } ] }, { "name": "config", "description": "Configure a pack based on config schema", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name", "description": "Name" } ] } ] }, { "name": "policy", "description": "Policy that is enforced on a resource", "subcommands": [ { "name": "list", "description": "Get the list of policies", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] }, { "names": [ "-r", "--resource-ref" ], "description": "Return policies for the resource ref", "args": [ { "name": "RESOURCE_REF" } ] }, { "names": [ "-pt", "--policy-type" ], "description": "Return policies of the policy type", "args": [ { "name": "POLICY_TYPE" } ] } ] }, { "name": "get", "description": "Get individual policy", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID", "isVariadic": true } ] }, { "name": "create", "description": "Create a new policy", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "update", "description": "Updating an existing policy", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" }, { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete", "description": "Delete an existing policy", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] } ] }, { "name": "policy-type", "description": "Type of policy that can be applied to the resources", "subcommands": [ { "name": "list", "description": "Get the list of policy types", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-r", "--resource-type" ], "description": "Return policy types for the resource type", "args": [ { "name": "RESOURCE_TYPE" } ] } ] }, { "name": "get", "description": "Get individual policy type", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] } ] }, { "name": "rule", "description": "A specification to invoke an 'action' on a 'trigger' selectively based on some criteria'", "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent rules", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-n", "--last" ], "description": "List N most recent; use -n -1 to fetch the full result set", "args": [ { "name": "LAST", "suggestions": [ "10", "5", "1", "-1" ] } ] }, { "names": [ "--iftt" ], "description": "Show trigger and action in display list" }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] }, { "names": [ "--enabled" ], "description": "Show enabled" }, { "names": [ "--disabled" ], "description": "Show disabled" }, { "names": [ "--action" ], "description": "Action reference to filter the list", "args": [ { "name": "ACTION" } ] }, { "names": [ "-g", "--trigger" ], "description": "Trigger type reference to filter the list", "args": [ { "name": "TRIGGER" } ] } ] }, { "name": "get", "description": "Get individual rule", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "create", "description": "Create a new rule", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "update", "description": "Update an existing rule", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" }, { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete", "description": "Delete an existing rule", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "enable", "description": "Enable an existing rule", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "disable", "description": "Disable an existing rule", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] } ] }, { "name": "webhook", "description": "Webhooks", "subcommands": [ { "name": "list", "description": "Get the list of webhooks", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] } ] }, { "name": "get", "description": "Get individual webhooks", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "url", "description": "URL", "isVariadic": true } ] } ] }, { "name": "timer", "description": "Timers", "subcommands": [ { "name": "list", "description": "Get the list of timers", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-ty", "--timer-type" ], "description": "List timers type, example: 'core.st2.IntervalTimer', 'core.st2.DateTimer', 'core.st2.CronTimer'", "args": [ { "name": "TIMER_TYPE", "suggestions": [ "core.st2.IntervalTimer", "core.st2.DateTimer", "core.st2.CronTimer" ] } ] } ] }, { "name": "get", "description": "Get individual timer", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "name-or-id", "description": "Name or ID", "isVariadic": true } ] } ] }, { "name": "runner", "description": "Runner is a type of handler for a specific class of actions", "subcommands": [ { "name": "list", "description": "List of commands for managing runners", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] }, { "name": "get", "description": "Get individual runner", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "name-or-id", "description": "Name or ID", "isVariadic": true } ] }, { "name": "enable", "description": "Enable an existing runner", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name-or-id", "description": "Name or ID" } ] }, { "name": "disable", "description": "Disable an existing runner", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name-or-id", "description": "Name or ID" } ] } ] }, { "name": "sensor", "description": "An adapter which allows you to integrate StackStorm with external system", "subcommands": [ { "name": "list", "description": "Get the list of sensortypes", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] } ] }, { "name": "get", "description": "Get individual sensor", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID", "isVariadic": true } ] }, { "name": "enable", "description": "Enable an existing sensor", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "disable", "description": "Disalbe an existing sensor", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] } ] }, { "name": "trace", "description": "A group of executions, rules and triggerinstances that are related", "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent traces", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-n", "--last" ], "description": "List N most recent; use -n -1 to fetch the full result set", "args": [ { "name": "LAST", "suggestions": [ "10", "5", "1", "-1" ] } ] }, { "names": [ "-s", "--sort" ], "description": "Sort action executions by start timestamp, asc|ascending (earliest first) or desc|descending (latest first)", "args": [ { "name": "SORT_ORDER", "suggestions": [ "desc", "descending", "asc", "ascending" ] } ] }, { "names": [ "--trace-tag", "--trace_tag" ], "description": "A trace tag string to track execution later", "args": [ { "name": "TRACE_TAG" } ] }, { "names": [ "-e", "--execution" ], "description": "Execution to filter the list", "args": [ { "name": "EXECUTION" } ] }, { "names": [ "-r", "--rule" ], "description": "Rule to filter the list", "args": [ { "name": "RULE" } ] }, { "names": [ "--trigger_instance" ], "description": "Trigger instance id to filter the list", "args": [ { "name": "TRIGGER_INSTANCE" } ] }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] }, { "name": "get", "description": "Get individual trace", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-e", "--execution" ], "description": "Execution to filter the list", "args": [ { "name": "EXECUTION" } ] }, { "names": [ "-r", "--rule" ], "description": "Rule to filter the list", "args": [ { "name": "RULE" } ] }, { "names": [ "--trigger_instance" ], "description": "Trigger instance id to filter the list", "args": [ { "name": "TRIGGER_INSTANCE" } ] }, { "names": [ "--show-executions" ], "description": "Only show executions" }, { "names": [ "--show-rules" ], "description": "Only show rules" }, { "names": [ "-n", "--hide-noop-triggers" ], "description": "Hide noop trigger instances" } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] } ] }, { "name": "trigger", "description": "An external event that is mapped to a st2 input. It is the st2 invocation point", "subcommands": [ { "name": "list", "description": "Get the list of triggers", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-p", "--pack" ], "description": "Only return resources belonging to the provided pack", "args": [ { "name": "PACK" } ] } ] }, { "name": "get", "description": "Get individual trigger", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID", "isVariadic": true } ] }, { "name": "create", "description": "Create a new trigger", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "update", "description": "Updating an existing trigger", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" }, { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete", "description": "Delete an existing trigger", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref-or-id", "description": "Reference or ID" } ] }, { "name": "getspecs", "description": "Return Trigger Specifications of a Trigger", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "ref", "description": "Reference" } ] } ] }, { "name": "trigger-instance", "description": "Actual instances of triggers received by st2", "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent triggerinstances", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-n", "--last" ], "description": "List N most recent; use -n -1 to fetch the full result set", "args": [ { "name": "LAST", "suggestions": [ "10", "5", "1", "-1" ] } ] }, { "names": [ "-tg", "timestamp-gt" ], "description": "Only return executions with timestamp greater than the one provided. Use time in the format '2000-01-01T12:00:00.000Z'", "args": [ { "name": "TIMESTAMP_GT" } ] }, { "names": [ "-tl", "timestamp-lt" ], "description": "Only return executions with timestamp lower than the one provided. Use time in the format '2000-01-01T12:00:00.000Z'", "args": [ { "name": "TIMESTAMP_LT" } ] }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "-g", "--trigger" ], "description": "Trigger type reference to filter the list", "args": [ { "name": "TRIGGER" } ] }, { "names": [ "--status" ], "description": "Only return executions with the provided status. Possible values are 'succeeded', 'running', 'scheduled', 'paused', 'failed', 'canceling' or 'canceled'", "args": [ { "name": "STATUS", "suggestions": [ "succeeded", "running", "scheduled", "paused", "failed", "canceling", "canceled" ] } ] } ] }, { "name": "get", "description": "Get individual trigger instance", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "re-emit", "description": "Re-emit a particular trigger instance", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] } ] }, { "name": "rule-enforcement", "description": "Models that represent enforcement of rules", "subcommands": [ { "name": "list", "description": "Get the list of the 50 most recent rule enforcements", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-tg", "timestamp-gt" ], "description": "Only return executions with timestamp greater than the one provided. Use time in the format '2000-01-01T12:00:00.000Z'", "args": [ { "name": "TIMESTAMP_GT" } ] }, { "names": [ "-tl", "timestamp-lt" ], "description": "Only return executions with timestamp lower than the one provided. Use time in the format '2000-01-01T12:00:00.000Z'", "args": [ { "name": "TIMESTAMP_LT" } ] }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "--trigger_instance" ], "description": "Trigger instance id to filter the list", "args": [ { "name": "TRIGGER_INSTANCE" } ] }, { "names": [ "-e", "--execution" ], "description": "Execution to filter the list", "args": [ { "name": "EXECUTION" } ] }, { "names": [ "-r", "--rule" ], "description": "Rule to filter the list", "args": [ { "name": "RULE" } ] } ] }, { "name": "get", "description": "Get individual rule enforcement", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] }, { "name": "create", "description": "Create a new rule enforcement", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "update", "description": "Update an existing rule enforcement", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name-or-id", "description": "Name or ID" }, { "name": "file", "description": "JSON/YAML file", "template": "filepaths" } ] }, { "name": "delete", "description": "Delete an existing rule enforcement", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ], "args": [ { "name": "name-or-id", "description": "Name or ID" } ] } ] }, { "name": "workflow", "description": "An adapter which allows you to integrate StackStorm with external system", "subcommands": [ { "name": "inspect", "description": "Inspect workflow definition and return the list of errors if any", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "--file" ], "description": "Local file path to the workflow definition", "args": [ { "name": "FILE", "template": "filepaths" } ] }, { "names": [ "--action" ], "description": "Action reference to filter the list", "args": [ { "name": "ACTION" } ] } ] } ] }, { "name": "service-registry", "description": "Service registry group and membership related commands", "subcommands": [ { "name": "group", "description": "Manage service registry groups", "subcommands": [ { "name": "list", "description": "Get list of groups", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] } ] }, { "name": "member", "description": "Manage service registry members", "subcommands": [ { "name": "list", "description": "Get list of group members", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] }, { "names": [ "--group-id" ], "description": "Group ID", "args": [ { "name": "GROUP_ID" } ] } ] } ] } ] }, { "name": "role", "description": "RBAC roles", "subcommands": [ { "name": "list", "description": "Get the list of the roles", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-s", "--system" ], "description": "Only display system roles" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] }, { "name": "get", "description": "Get individual role", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] } ], "args": [ { "name": "id", "description": "ID", "isVariadic": true } ] } ] }, { "name": "role-assignment", "description": "RBAC role assignments", "subcommands": [ { "name": "list", "description": "Get the list of role assignments", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" } ] }, { "name": "get", "description": "Get individual assignment", "parserDirectives": { "optionsMustPrecedeArgs": true }, "options": [ { "names": [ "-h", "--help" ], "description": "Show this help and exit" }, { "names": [ "-t", "--token" ], "description": "Access token for user authentication. Get ST2_AUTH_TOKEN from the environment variables by default", "args": [ { "name": "TOKEN" } ] }, { "names": [ "--api-key" ], "description": "Api Key for user authentication. Get ST2_API_KEY from the environment variables by default", "args": [ { "name": "API_KEY" } ] }, { "names": [ "-j", "--json" ], "description": "Print output in JSON format" }, { "names": [ "-y", "--yaml" ], "description": "Print output in YAML format" }, { "names": [ "-r", "--role" ], "description": "Role to filter on", "args": [ { "name": "ROLE" } ] }, { "names": [ "-u", "--user" ], "description": "User under which to run the action (admins only)", "args": [ { "name": "USER" } ] }, { "names": [ "-s", "--source" ], "description": "Source to filter on", "args": [ { "name": "SOURCE" } ] }, { "names": [ "--remote" ], "description": "Only display remote role assignments" }, { "names": [ "--attr" ], "description": "List of attributes to include in the output. 'all' or unspecified will return all attributes", "args": [ { "name": "ATTR", "isVariadic": true } ] }, { "names": [ "-w", "--width" ], "description": "Set the width of the columns in output", "args": [ { "name": "WIDTH", "isVariadic": true } ] } ] } ] } ] }