Documentation

Managing the Workspace

The workspace is the root container for all your work in PostPilot. It stores your collections, environments, and database connections.

Platform storage

The way your workspace is stored depends on the platform you are using:

PlatformStorage Method
DesktopA local folder on your computer. You can open existing workspaces or create new ones.
WebA single workspace stored in your browser's local storage.

(desktop only) To switch or create a workspace, use the Open Workspace option to select a directory on your filesystem.

Collections

A Collection is the required top-level logical group for your work. You might create a collection for a specific micro-service (e.g., order-service) or a public API.

Creating and Importing

  • New Collection: Click the + icon in the sidebar to create an empty collection.
  • Import: You can import existing collections from OpenAPI (Swagger) specifications or Postman Collection v2.1 files.

Folders and Items

Within a collection, you can organize your work using folders and individual items.

Items

Items are the individual units of work you perform:

Nesting

Folders are optional and can be nested to any depth to help you sub-group related requests or queries.

Organizing the Workspace

Each collection, folder, and item has a ... options menu.

Collection and Folder options

Click the ... icon on a collection or folder to:

  • Add API Request, Add DB Query, or Add Data Viewer.
  • Add Folder.
  • Rename or Delete the group.

Item options

Click the ... icon on an individual item to:

  • Rename: Change the display name.
  • Duplicate: Create an exact copy in the same location.
  • Delete: Remove the item from the workspace.

Reordering and Moving

You can reorder any item, folder, or collection using drag and drop. You can also move items between different folders or collections by dragging them to the new parent node.

Environments and Connections

Your workspace also contains two special internal folders: