| \n\nField\n\n | \n\nDescription\n\n |
|---|---|
| \n\nName\n\n | \n\nRequired. Name of the command.\n\n |
| \n\nCommand Group\n\n | \n\nRequired. Command group that the command is a part of.\n\n |
| \n\nReference Command\n\n | \n\nCommand to reference. For example, you can create a new command as an alias for an existing command. When the user calls the new command, the original command executes. This enables you to create a command specific to your custom application that executes existing functionality.**Note:** A command cannot reference a command that references another command, or reference a descendant command, an ancestor command, or a callback command.\n\n |
| \n\nAPI Endpoint\n\n | \n\nRequired. API call to execute when the user runs the command.\n\n |
| \n\nShort Description\n\n | \n\nRequired. Short description of the command.\n\n |
| \n\nApplication\n\n | \n\nRead-only application scope for the command.\n\n |
| \n\nActive\n\n | \n\nWhen selected, the command is active.\n\n |
| \n\nIs Callback Command\n\n | \n\nWhen true, designates the command as a callback command. Select this option to hide the command from the CLI client and prevent users from calling it from the command line. Use this field with the **Callback** section of a primary command. The callback command executes when the primary command is complete.\n\n |
| \n\n**Help Text**\n\n | |
| \n\nDescription\n\n | \n\nDescription of the command used as help text when the user runs the `--help` command.\n\n |
| \n\nExamples\n\n | \n\nExamples of the command used as help text when the user runs the `--help` command.\n\n |
| \n\n**Expressions**\n\n | |
| \n\nSuccess Expression\n\n | \n\nExpression used to evaluate the response from the server and determine if the command succeeded. For example, `result.code = 1`.\n\n |
| \n\nFailure Expression\n\n | \n\nExpression used to evaluate the response from the server and determine if the command failed.\n\n |
| \n\n**Messages**\n\n | |
| \n\nSuccess Message\n\n | \n\nMessage displayed on the CLI client when the command is successful.\n\n |
| \n\nProgress Message\n\n | \n\nMessage displayed on the CLI client when the command is in progress.\n\n |
| \n\nFailure Message\n\n | \n\nMessage displayed on the CLI client when the command fails.\n\n |
| \n\n**Callback**\n\n | |
| \n\nCallback Expression\n\n | \n\nExpression used to determine whether to execute the callback command. For example, you can write an expression that checks on a long-running process. If the expression produces a certain result, the callback executes.\n\n |
| \n\nCallback Command\n\n | \n\nCommand to execute when the **Callback Expression** is satisfied. Must be a command with the **Is Callback Command** field selected.\n\n |
| \n\nCallback Interval\n\n | \n\nThe interval between callback command executions. Unit: Milliseconds\n\n Default: 1,000\n\n |
| \n\nMax Retries\n\n | \n\nMaximum number of times the callback command executes. Default: 10\n\n |
| \n\nField\n\n | \n\nDescription\n\n |
|---|---|
| \n\nName\n\n | \n\nRequired. Name of the command argument, for example `data`.\n\n |
| \n\nShort Name\n\n | \n\nShort dame of the command argument, for example `d`.\n\n |
| \n\nData Type\n\n | \n\nRequired. Type of data expected for the command argument. Options include:- String: Allows users to enter a string as input.\n- Integer: Allows users to enter a number as input.\n- Boolean: Allows users to enter `true` or `false` as input.\n- File Input: Allows users to upload a file as input. Map this argument to a Body **Parameter Type** in the API Endpoint Arguments related list in the next step. Users can pass plain text, YAML, JSON, or another file type accepted by the REST API. When the user submits a YAML file, the CLI client converts to file to JSON format by default. Use the **Skip Pre-processing** field to disable this behavior.\n- Password: Allows users to securely enter a password as input.\n **Note:** For File Input data types, the file size limit is 10 MB by default. However, you change this limit using the **glide.rest.scripted.max\\_inbound\\_content\\_length\\_mb** system property.\n\n |
| \n\nSkip Pre-processing\n\n | \n\nSet this flag to prevent the CLI client from converting YAML files into JSON format before sending them in the request. When **Data Type** is set to **File Input** and the user submits a YAML file, the CLI client converts the file to JSON before executing the command by default.**Note:** Only applies when **Data Type** is set to **File Input**.\n\n |
| \n\nDefault Value\n\n | \n\nDefault value to use when the user does not pass a value.\n\n |
| \n\nShort Description\n\n | \n\nRequired. Short description of the command argument. Used as help text when the user runs the `--help` command.\n\n |
| \n\nApplication\n\n | \n\nRead-only application scope for the argument.\n\n |
| \n\nCommand\n\n | \n\nRequired. Command that the argument applies to.\n\n |
| \n\nMandatory\n\n | \n\nWhen selected, the user must provide a value for the argument when running the associated command.\n\n |
| \n\nPrompt\n\n | \n\nPrompt to request information from the user. The CLI prompts for information when the user does not include a required argument in a command.\n\n |
| \n\nVisibility Expression\n\n | \n\nExpression used to determine whether the CLI should prompt for the argument. Typically used to display an argument based on the value provided to a previous argument.\n\n |
| \n\nOrder\n\n | \n\nOrder in which to prompt for the argument.\n\n |
| \n\nField\n\n | \n\nDescription\n\n |
|---|---|
| \n\nName\n\n | \n\nRequired. Name of the argument.\n\n |
| \n\nValue\n\n | \n\nRequired. The value from the command that you want to pass to the REST endpoint. You can pass a static value, or an expression such as `{flags.table}`. Use the `flags` global variable to access the command arguments.\n\n |
| \n\nParameter Type\n\n | \n\nRequired. The type of parameter in the REST endpoint that you want to pass the **Value** to. For example, if you select **Body**, the CLI passes the value of the **Value** field to the REST endpoint body. Options include:- Body\n- Header\n- Path\n- Query\n\n\n |
| \n\nApplication\n\n | \n\nRead-only application scope for the argument.\n\n |
| \n\nCommand\n\n | \n\nRequired. Command that the argument applies to.\n\n |