Skip to content

OpenAPI Explorer

Access the interactive API documentation (Swagger UI) for CertifyClouds.

Live API Documentation

The CertifyClouds application includes built-in interactive API documentation powered by Swagger UI.

Access Swagger UI

Navigate to the /docs endpoint on your CertifyClouds instance:

https://your-certifyclouds-instance/docs

Or for local development: 

http://localhost:8080/docs

Features

The Swagger UI provides:

  • Interactive testing: Try API calls directly from the browser
  • Request/response examples: See sample payloads
  • Schema documentation: View all data models
  • Authentication: Authorize with your JWT token

OpenAPI Specification

Download the OpenAPI specification for use with other tools:

https://your-certifyclouds-instance/openapi.json

Using with Tools

Import the OpenAPI spec into:

  • Postman: Import collection from URL
  • Insomnia: Import OpenAPI spec
  • VS Code REST Client: Generate requests
  • Code generators: Generate client SDKs

Authentication in Swagger UI

To test authenticated endpoints in Swagger UI:

  1. Click the Authorize button (lock icon)
  2. Enter your token in the bearerAuth field: 
    Bearer <your-token>
  3. Click Authorize
  4. Now you can test authenticated endpoints

Getting a Token

First, use the /auth/login endpoint to get a token:

  1. Find POST /auth/login in Swagger UI
  2. Click Try it out
  3. Enter your credentials
  4. Copy the access_token from the response
  5. Use it in the Authorize dialog

Alternative Documentation

In addition to Swagger UI, CertifyClouds provides:

  • ReDoc: Alternative API docs at /redoc
  • OpenAPI JSON: Raw spec at /openapi.json

API Versioning

Currently, CertifyClouds uses a single API version. The API is stable and follows semantic versioning for breaking changes.

When a new major version is released:

  • New endpoints will be available at /api/v2/...
  • Existing /api/... endpoints will continue working
  • Deprecation notices will be provided in advance

Rate Limits

When testing via Swagger UI, be mindful of API rate limits. Exceeding limits returns 429 Too Many Requests.

Support

For API questions not answered in the documentation: