Getting Started

Welcome to the Apinizer Management API documentation. This section provides essential information to get you started with the Management API.

Overview

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

See Overview for detailed information about the Management API.

Quick Start Guide

1. Understand the Base URL: Learn how to construct the API base URL for your Apinizer instance.
   • Base URL
2. Get Your API Token: Obtain a Personal API Access Token to authenticate your requests.
   • Authentication
3. Understand Error Handling: Learn how the API handles errors and what to expect.
   • Error Handling
4. Start Using the API: Explore the API Reference to find endpoints for your use case.

Documentation Sections

• Overview - Introduction to the Management API
• Authentication - How to obtain and use API tokens
• Base URL - How to construct the API base URL
• Error Handling - Understanding API error responses

Next Steps

After completing the getting started guide, explore the API Reference to find endpoints for:

• Managing projects and environments
• Creating and managing API proxies
• Configuring policies
• Managing connections, credentials, and certificates
• And much more…

Related Documentation

• API Reference - Complete API endpoint documentation
• Appendix - Glossary, variable definitions, enum references, and OpenAPI spec