Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


Swagger Documentation - https://localhost/apidocs

openapi.yaml - https://localhost/openapi.yaml

StorCycle API Examples

This repository contains examples for interacting with the StorCycle API. These general examples require either creation of the example directory tree, or adjusting variables to suit the local system.

To use the examples, client code must first be generated in the desired language.


Generate the code:

Download and navigate to the openapi.yaml file from which the client will be generated.

NOTE: Pre-generated Python clients for evaluation are available at: releases. Users are advised to generate OpenAPI clients for production releases, to ensure that client software uses the latest API.

Command Line:

Download the open api generator here. In the command line terminal locate the openapi.yaml file and generate the client code in a temporary (or your desired) directory:

java -jar openapi/codegen/1283369100_openapi-generator-cli-4.3.1.jar generate -g python -i openapi.yaml -o /tmp/


Download a client generator plugin for your local IDE and install. Note that while the OpenAPI Generator plugin by Jim Schubert was used within JetBrains IntelliJ to generate the example Python client, any client generator should be adequate.

Use the now installed openapi generator plugin to generate client code from the openapi.yaml file.

ex: Code -> OpenAPI -> Generate from Document

Navigate to the desired language (Python) and fill in the appropriate values for package name etc. Then generate.

Run Example Code:

Download and place the example Python code within the directory to which the generated client code has been saved.

Create the example directory tree used in the example code or change example variable fields to appropriate local system values.

Example directory tree at the C:/ level. You need to either create this directory structure populated with some files in the source subdirectories, or populate with an appropriate local directory tree.

  • C:/ApiPythonExampleData/example-source-storage-location/WorkingDirectory/ExcludeDirectory
  • C:/ApiPythonExampleData/example-source-storage-location/WorkingDirectory/IncludeDirectory
  • C:/ApiPythonExampleData/example-source-storage-location-optional/WorkingDirectory/ExcludeDirectory
  • C:/ApiPythonExampleData/example-source-storage-location-optional/WorkingDirectory/IncludeDirectory
  • C:/ApiPythonExampleData/example-target-storage-location/
  • C:/ApiPythonExampleData/example-target-storage-location-optional

Command Line: Navigate to the examples file in the terminal and run the examples program:



Load the generated client code into a project. Navigate to the examples file and run from main to run each example.