Management API Overview

Introduction

The Apinizer Management API provides programmatic access to Apinizer functionality, allowing you to manage projects, API proxies, policies, connections, and more without using the web interface.

Base URL

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

{management_console_url}/apiops/

Example

Manager URL: https://demo.apinizer.com
API Base URL: https://demo.apinizer.com/apiops/

Authentication

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

Authorization: Bearer YOUR_TOKEN

See Authentication for details on obtaining a token.

API Versioning

The current API version is v1. All endpoints are under the /apiops/ path.

Response Format

Success Response

Most endpoints return a standard success response:

{
  "success": true,
  "resultList": [...],
  "resultCount": 1
}

Error Response

Error responses follow this format:

{
  "error": "error_code",
  "error_description": "Human-readable error message"
}

See Error Handling for details on error codes and handling.

HTTP Methods

The API uses standard HTTP methods:

GET - Retrieve resources
POST - Create resources
PUT - Update resources (full update)
PATCH - Partial update (where supported)
DELETE - Delete resources

Content Types

Request: application/json (for POST/PUT requests)
Response: application/json

Common Headers

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication
Content-Type	Yes (POST/PUT)	`application/json`

Response Headers

Header	Description
Content-Type	`application/json;charset=UTF-8`

Path Parameters

Path parameters are used in URL paths:

/apiops/projects/{projectName}/apiProxies/{apiProxyName}/

Where {projectName} and {apiProxyName} are path parameters.

Query Parameters

Query parameters are optional and used for filtering, pagination, etc.:

/apiops/projects/?page=1&size=10

Apinizer Management API Documentation