https://github.com/purestorage-openconnect/swagger

This is a tool that provides the Pure FlashArray and FlashBlade API documentation into the popular interactive Swagger UI. This lets you browse the API documentation in a convienent format and even execute API calls interactively directly to a FlashArray or FlashBlade!
https://github.com/purestorage-openconnect/swagger

Last synced: about 1 month ago
JSON representation

This is a tool that provides the Pure FlashArray and FlashBlade API documentation into the popular interactive Swagger UI. This lets you browse the API documentation in a convienent format and even execute API calls interactively directly to a FlashArray or FlashBlade!

• Host: GitHub
• URL: https://github.com/purestorage-openconnect/swagger
• Owner: PureStorage-OpenConnect
• License: apache-2.0
• Created: 2018-05-15T00:02:27.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-07-30T15:41:55.000Z (7 months ago)
• Last Synced: 2025-08-18T15:52:58.394Z (6 months ago)
• Language: Python
• Homepage:
• Size: 24.4 MB
• Stars: 18
• Watchers: 4
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Pure Swagger

This is a tool that provides the Pure Storage FlashArray and FlashBlade API documentation into the popular interactive Swagger UI.  This lets you browse the API documentation in a convenient format and even execute API calls interactively directly to a FlashArray or FlashBlade!

## Try It: 

Requires [docker](https://docs.docker.com/install/) to be installed

> docker run -it --rm -p 127.0.0.1:80:5000 quay.io/purestorage/swagger 

Then open your browser to http://127.0.0.1

Then select an API spec and enter your FlashArray or FlashBlade IP.

## To stop run:

just ctrl^c on the console docker container 

## Update to the latest version

> docker pull quay.io/purestorage/swagger

> 

## Authentication Examples Videos

### FlashBlade 1.x API Token

[Flash Blade 1.x Token Auth](https://youtu.be/EvtVio8s7Eg)

### FlashArray 1.x API Token

[Flash Array 1.x Token Auth](https://youtu.be/fWa1VhYsWdg)

### FlashArray 2.2+ API Token

[Flash Array 2.x Token Auth](https://youtu.be/OAeGKG-BkUs)

### FlashArray 2.0+ OAuth2 API Client Auth

[Flash Array 2.x OAuth2](https://youtu.be/LyIE3bkdQok)

## Screenshots

### Documentation in collapsable easy to read format

![docs](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/docs.png)

### See detailed paramater information

![array_details](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/array_details.png)

### See body param documentation

![array_details](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/body_params.png)

### Every Endpoint is documented !

![array_details](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/list_of_endpoints.png)

### Actually send API commands to an Array:

![array_details](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/list_api.png)

### Start a session:

![array_details](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/start_session.png)

### Get Controller Info:

![array_details](https://raw.githubusercontent.com/PureStorage-OpenConnect/swagger/master/images/get_controllers.png)

## Notes:

In order to send API calls to an array you must 

1.  Have a FlashArray or FlashBlade and login credentials