Usage

First read and follow the First Steps chapter to install and setup Restsh correctly.

Interactive mode

1. Start Restsh: restsh

2. Select configuration to use.

3. Restsh prompts for credentials if not defined in the configuration file.

4. The prompt changes to the Restsh prompt that shows your current working directory, git branch and the configured REST endpoint.

In this mode you can use all the commands you know from your linux environment and additional special commands defined by Restsh and the loaded modules. Type restsh.help to get an overview of the configured environment and available commands.

HTTP methods

Restsh defines the special DELETE, GET, HEAD, PATCH, POST, PUT commands that connects directly to the endpoint defined by RESTSH_HOST.

GET /api/version translates to https://<rest endpoint>/api/version. Restsh transparently handles the authentication for you.

• HTTP functions

Hint

Restsh provides autocompletion for F5, GitLab and SCM REST API endpoints. Simply start typing and press TAB for completion, e. g. GET /mgmt/tm/.

Scripted mode

• Scripting

Functions

• Functions

• Modules

  • Certificates

  • F5 TMOS

  • F5OS-A / rSeries

  • GitLab

  • Sectigo Cert Manager