Skip to main content

OpenAPI Specification

Interactive API documentation and OpenAPI specification for the CuliUptime API.

🔗 Interactive Documentation​

Swagger UI​

Explore and test the CuliUptime API interactively:

Cloud Service: https://uptime.culiops.net/docs Self-Hosted: https://your-domain.com/docs

ReDoc Documentation​

Alternative documentation interface:

Cloud Service: https://uptime.culiops.net/redoc Self-Hosted: https://your-domain.com/redoc

📄 OpenAPI Files​

JSON Format​

Download the OpenAPI specification in JSON format:

Cloud Service: https://uptime.culiops.net/openapi.json Self-Hosted: https://your-domain.com/openapi.json

YAML Format​

Download the OpenAPI specification in YAML format:

Cloud Service: https://uptime.culiops.net/openapi.yaml Self-Hosted: https://your-domain.com/openapi.yaml

🛠️ Code Generation​

Use the OpenAPI specification to generate client libraries:

OpenAPI Generator​

# Install OpenAPI Generator
npm install -g @openapitools/openapi-generator-cli

# Generate Python client
openapi-generator-cli generate \
  -i https://uptime.culiops.net/openapi.json \
  -g python \
  -o ./culiuptime-python-client

# Generate JavaScript client
openapi-generator-cli generate \
  -i https://uptime.culiops.net/openapi.json \
  -g typescript-fetch \
  -o ./culiuptime-js-client

# Generate PHP client
openapi-generator-cli generate \
  -i https://uptime.culiops.net/openapi.json \
  -g php \
  -o ./culiuptime-php-client

Postman Collection​

Import the API into Postman for testing:

  1. Open Postman
  2. Go to Import → Link
  3. Enter: https://uptime.culiops.net/openapi.json
  4. Click Import

📖 Specification Details​

The OpenAPI specification includes:

  • All API endpoints with request/response schemas
  • Authentication requirements (Bearer token)
  • Error responses and status codes
  • Request/response examples
  • Data models and validation rules
  • Rate limiting information

🔄 API Versioning​

The CuliUptime API uses URL-based versioning:

  • Current Version: v1
  • Base URL: https://uptime.culiops.net/api/v1
  • Specification: Updates automatically with API changes
  • Backward Compatibility: Maintained within major versions

🚀 Getting Started​

  1. Generate an API token
  2. Try the interactive docs
  3. Download the specification
  4. Generate a client library
  5. Start building your integration

The OpenAPI specification is the definitive reference for the CuliUptime API! 📚