Apinizer Management API Documentation

Welcome to the Apinizer Management API documentation. This documentation provides comprehensive information about all available endpoints, request/response formats, and usage examples.

The Management API allows you to perform many operations without needing the web interface, enabling integration of Apinizer into your DevOps environment.

Base URL

The Management API base URL is constructed by appending /apiops to your Apinizer Manager application URL.

Example

• If Manager application runs at https://demo.apinizer.com, the API base URL is https://demo.apinizer.com/apiops/

For more details, see Base URL.

OpenAPI Specification

You can view the OpenAPI specification files online:

• Interactive documentation: https://{management_console_url}/apiops/openapi
• YAML specification: https://{management_console_url}/apiops/openapi.yaml

For example:

• https://demo.apinizer.com/apiops/openapi
• https://demo.apinizer.com/apiops/openapi.yaml

See OpenAPI Spec for more information.

📚 Table of Contents

• Getting Started
  • Overview
  • Authentication
  • Base URL
  • Error Handling
• API Reference
  • Authentication
  • Projects
  • Environments
  • API Proxies
  • Policies
  • Connections
  • Credentials
  • Certificates
  • API Proxy Groups
  • Environment Variables
  • IP Groups
  • RLCL
  • GeoLocation
  • Reports
  • Test
• Appendix
  • Glossary
  • Variable Definition
  • Enum Reference
  • OpenAPI Spec

🚀 Quick Start

1. Get Your API Token: See Authentication for details on obtaining a Personal API Access Token.

2. Make Your First Request:

   curl -X GET \
     "https://demo.apinizer.com/apiops/projects/" \
     -H "Authorization: Bearer YOUR_TOKEN"
   

3. Explore the APIs: Start with Projects to list available projects.

📖 Documentation Structure

Each API endpoint documentation includes:

• Endpoint URL and HTTP method
• Authentication requirements
• Request parameters, headers, and body structure
• Response formats (success and error)
• Full JSON examples for all operations
• cURL examples for quick testing

🔑 Authentication

All endpoints (except the test endpoint) require authentication using a Personal API Access Token. Include the token in the Authorization header:

Authorization: Bearer YOUR_TOKEN

Note: Each endpoint may require different permissions based on the operation it performs.

See Authentication Guide for details on obtaining and using API tokens.

📄 License

[Add license information here]

🔗 Related Resources

• Apinizer Documentation
• Apinizer Management Console

📧 Support

For questions or issues, please contact support@apinizer.com