API Reference

This section contains comprehensive documentation for all Management API endpoints organized by functionality.

Overview

The Management API provides endpoints for managing all aspects of your Apinizer deployment, including projects, API proxies, policies, connections, credentials, certificates, and more.

API Sections

Authentication

Projects

Environments

API Proxies

  • API Proxies Overview - Complete API Proxy management documentation
  • Create, update, delete, import, export API proxies
  • Manage endpoints, policies, and settings
  • Deploy and undeploy API proxies

Policies

  • Policies Overview - Complete policy management documentation
  • Authentication policies (Basic, JWT, OAuth2, OIDC, etc.)
  • Security policies (WS-Security, JOSE, Encryption, etc.)
  • Rate limiting and quota policies
  • Transformation and validation policies
  • Scripting and integration policies

Connections

  • Connections Overview - Complete connection management documentation
  • Database, ActiveMQ, Kafka, RabbitMQ connections
  • Email, FTP, LDAP connections
  • Webhook, SNMP, Syslog connections
  • And more…

Credentials

  • Credentials Overview - Complete credential management documentation
  • Create, update, delete credentials
  • Manage credential access and passwords

Certificates

  • Certificates Overview - Complete certificate management documentation
  • Create, update, delete certificates
  • Export certificates and manage truststore

API Proxy Groups

  • API Proxy Groups Overview - Complete API Proxy Group management documentation
  • Create, update, delete groups
  • Add/remove API proxies to groups
  • Deploy and undeploy groups

Environment Variables

IP Groups

  • IP Groups Overview - Complete IP group management documentation
  • Create, update, delete IP groups
  • Manage IP addresses in groups

RLCL (Rate Limit, Connection Limit)

  • RLCL Overview - Complete RLCL management documentation
  • Manage rate limits and connection limits
  • Configure conditions, credentials, and endpoints

GeoLocation

  • GeoLocation Overview - Complete geolocation management documentation
  • Enable/disable geolocation
  • Upload MMDB files

Reports

  • Reports Overview - Complete reporting documentation
  • API reports
  • Organization API data model access reports

Test

Authentication

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

Authorization: Bearer YOUR_TOKEN

See Authentication Guide for details.

Base URL

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

For example:

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

See Base URL for more details.

Error Handling

All endpoints follow a consistent error response format. See Error Handling for details.

  • Getting Started - Overview and quick start guide
  • Appendix - Glossary, variable definitions, enum references, and OpenAPI spec