Accessing Swagger Definitions

Accessing Swagger definitions may only be done on an on-premises instance of SureDrop, Swagger definitions are disabled by default for all cloud instances.

To access the swagger.json definition file, edit the following file:

C:\ProgramData\docker\volumes\suredrop_ngix-reverse-proxy-shared\_data\client.conf

Add the following lines:

location /api-docs/swagger.json {
	proxy_pass   http://rest-api/api-docs/swagger.json;
}

Restart SureDrop:

suredrop stop
suredrop start

The Swagger definitions will now be available at:

https://[your-suredrop-url]/api-docs/swagger.json

Please note, there is no SwaggerUI configured at this address.