logo
API Manager Documentation 4.3.0
Admin API v4
4.3.0
  • Show all
Initializing search
    wso2/docs-apim
    • Home
    • Get Started
    • Design APIs
    • Deploy and Publish APIs
    • Consume APIs
    • Streaming
    • Analytics
    • Observe
    • Reference
    • Administer
    • Install and Setup
    • Tutorials
    Report Issues
    wso2/docs-apim
    • Documentation
      • Overview
      • Key Concepts
      • Architecture
        • API Management
        • Streaming
      • About this Release
      • Design APIs Overview
          • Create a REST API
          • Create a REST API from an OpenAPI Definition
          • Expose a SOAP Service as a REST API
          • Generate REST API from SOAP Backend
          • Test a REST API
        • GraphQL APIs
          • Streaming API Overview
          • Create a WebSocket API
          • Create a WebSub/WebHook API
          • Create a SSE API
          • Create a Streaming API from an AsyncAPI Definition
          • Test a WebSub/WebHook API
        • Create an API From a Service
      • Create API Revisions
      • Add Custom Properties to APIs
      • Change the Thumbnail of an API
        • Overview
          • With API Gateway
        • Existing Backend Implementation as a Prototype API
        • API Product Overview
        • Create an API Product
        • Endpoint Types
          • Secure Endpoint with Basic Auth
          • Secure Endpoint with Digest Auth
          • Secure Endpoint with OAuth 2.0
        • High Availability for Endpoints
          • Endpoint Timeouts
          • Endpoint Suspension
          • Prevent API Suspension
        • Manage Certificates
        • API Lifecycle
        • Customize API Life Cycle
        • Create a New API Version
        • Deprecate the Old Version
        • Backward Compatibility
        • Enable Notifications
        • Add API Documentation
        • View Generated Documentation
        • Comment on an API via the Publisher
        • Enable Social Media Interaction
        • Overview
        • Attach Policies
        • Create a Policy
          • Add Dynamic Endpoints
          • Remove Specific Request Headers From Response
          • Pass a Custom Authorization Token to the Backend
          • URL Mapping
          • Disable Message Chunking
          • Transform API Message Payload
          • Add a Non-Blocking Send Operation
          • Add a Class Mediator
          • Configure Message Builders and Formatters
          • JWT claim based access validator
        • Revoke One Time Tokens Policy
          • Overview
          • Secure APIs using OAuth2 Access Tokens
          • Secure APIs using API Keys
          • Secure APIs using Mutual SSL
          • Secure APIs using Basic Authentication
          • Secure APIs using Certificate Bound Access Token
          • Federating OAuth Applications
          • Disable Security
          • Overview
          • Role-Based Access Control using Scopes
          • Role-Based Access Control using XACML
          • Publisher Portal in Read Only Mode
        • Secure APIs by Auditing API Definitions
          • JSON Schema Validator
            • JWT Access Tokens
            • Role-Based Access Control with OAuth Scopes
            • Scope Whitelisting
            • Overview
            • Password Grant
            • Client Credentials Grant
            • Authorization Code Grant
            • Refresh Token Grant
            • JWT Grant
            • SAML Extension Grant
            • Kerberos OAuth2 Grant
            • NTLM Grant
          • Token Revocation
          • Token Expiration
          • Token Persistence
          • Encrypting OAuth2 Tokens
          • Hashing OAuth Keys
          • Provisioning Out-of-Band OAuth Clients
          • Securing OAuth Token with HMAC Validation
          • Bot Detection
          • Gateway Threat Protectors
          • Regular Expression Threat Protection
          • JSON Threat Protection
          • XML Threat Protection
          • Obtain User Profile Information with OpenID Connect
          • Overview
          • Custom OPA Policy for Regualr Gateway
        • Throttling Use-Cases
        • Add New Throttling Policies
        • Set Throttling Limits
        • Access Control
        • Enforce Throttling and Resource Access Policies
        • Set Maximum Backend Throughput Limits
        • Rate Limiting for Streaming APIs
          • Overview
          • Query Depth Limit
          • Query Complexity Limit
          • Custom Rate Limiting
          • Distributed Burst Control, Backend Rate Limiting for API Gateway Cluster
        • Monetize an API
        • Enable Publisher Access Control
        • Control API Visibility and Subscription Availability in the Developer Portal
        • Enable CORS for APIs
        • Add an API State Change Workflow
        • Block Subscription to an API
        • Validate API Definitions with Linters
          • Deploy an API
          • Expose APIs via Custom Hostnames
          • Deploy Through Multiple API Gateways
          • Revision Deployment Workflow
          • Overview of the WSO2 API Gateway
          • Gateway Policies
          • Response Caching
            • Regular Expression Threat Protection
            • JSON Threat Protection
            • XML Threat Protection
          • Pass End User Attributes to the Backend
          • Gateway Environments
          • Scale the Gateway
            • API Gateways with Dedicated Backends
            • Mutual SSL Between API Gateway and Backend
            • Storing Custom Synapse Artifacts in the Gateway
        • Publish an API
        • Add a Third-party API
        • Publish to Multiple External API Developer Portals
        • Import APIs From AWS API-Gateway to WSO2 API-M
      • Consume APIs - Overview
        • Search
        • Marketplace Assistant
        • Create Application
          • Application Keys
            • Password Grant
            • Client Credentials Grant
            • JWT Grant
            • Kerberos OAuth2 Grant
            • Refresh Token Grant
            • Authorization Code Grant
            • SAML Extension Grant
            • NTLM Grant
          • Overview of Access Tokens
          • Access Tokens Per Device
          • Change the Default Token Expiration Time
          • Revoke OAuth2 Application
        • Share Applications
          • Add Custom Attributes to Applications
          • Change the Owner of an Application
          • Change the Provider of an Api
          • Add an Application Creation Workflow
          • Add an Application Key Generation Workflow
        • Subscribe to an API
          • Add an API Subscription Workflow
          • Add an API Subscription Tier Update Workflow
          • Add an API Subscription Deletion Workflow
          • Test a REST API
          • Test a GraphQL API
          • Add Additional Headers to Test a REST API
        • SOAP Client
        • Postman
        • Test APIs with API Chat
        • Interact with the Community
        • Generate SDKs in Developer Portal
        • Write a Client Application Using the SDK
        • Recover Password
        • Change Password
        • Token Persistence
      • Streaming Overview
      • Streaming Key Concepts
        • Streaming Integrator Usecase Overview
          • Streaming API Overview
          • Create a WebSocket API
          • Create a WebSub/WebHook API
          • Create a SSE API
          • Create a Streaming API from an AsyncAPI Definition
          • Test a WebSub/WebHook Streaming API
        • Extract Data from static Sources in Real Time
        • Receive Data in Transit
        • Load and Writing Data
        • Publish Data
          • Stream Processing Overview
          • Cleanse Data
          • Transform Data
          • Enrich Data
          • Summarize Data
          • Correlate Data
        • Handle Errors
        • Perform ETL Operations
        • Trigger Integration Flows
        • Expose a Stream as a Managed API
        • Develop Streaming Integrator Solutions
          • Streaming Integrator Tooling Overview
          • Work with the Design View
          • Work with the AsyncAPI View
        • Create Siddhi Applications
        • Install Siddhi Extensions
        • Test Siddhi Applications
        • Deploy Siddhi Applications
        • Export Siddhi Applications
          • Overview
          • Step 1 - Download Streaming Integrator and Dependencies
          • Step 2 - Create the Siddhi Application
          • Step 3 - Deploy the Siddhi Application
          • Step 4 - Run the Siddhi Application
          • Step 5 - Update the Siddhi Application
          • Step 6 - Handle Errors
          • Step 7 - Monitor Statistics
          • REST API Guide Overview
          • Siddhi Application Management APIs
          • Permission APIs
          • Business Rules APIs
          • Store APIs
          • Healthcheck APIs
          • HTTP Status Codes
      • Migrating from WSO2 SP
          • Capture MySQL Inserts via CDC
          • Capture MySQL Inserts and Updates via CDC Polling Mode
          • Publish and Receive CSV Events via Files
          • Receive Events via File
          • Text Mapping with In-memory Transport
          • Publish HTTP Requests, Receive Responses, and Processe Them
          • Consume Messages from IBM Message Queues
          • Receive Events via HTTP Transport
          • Receive XML Events via Email
          • Receive Messages from a Google Pub/Sub Topic
          • Receive ER7 Events via HL7
          • Receive Custom XML Messages via HL7
          • Receive XML Events via HTTP
          • Receive Custom XML Events via HTTP
          • Receive JSON Events via HTTP
          • Receive Custom JSON Events via HTTP
          • Receive JSON Events via JMS
          • Receive Key Value Events via JMS
          • Receive Binary Events via Kafka
          • Receive Custom Text Events via Kafka
          • Receive XML events via MQTT
          • Receive Prometheus Metrics
          • Receive JSON Events via RabbitMQ
          • Receive JSON Events via TCP
          • Receive Binary Events via TCP
          • Receive Custom Text Events via TCP
          • Receive Text Events via TCP
          • Receive XML Events via Websocket
          • Receive Custom Key Value Events via SNMP
          • Receive Data via TCP and Preprocessing
          • Receive Email Alerts
          • Publish Aggregated Events to the Amazon AWS S3 Bucket
          • Publish and Receive CSV Events via Files
          • Publish Events to a GCS Bucket
          • Publish JSON Events to Files
          • Receive Events via Simulator and Persist in Cassandra Store'
          • Receive Events via Simulator and Persisting in a Store
          • Work with an influxDB Store
          • Receive Events and Persisting in MongoDB Store
          • Receive Events via Simulator and Persisting in RDBMS Store
          • Receive Events and Persisting Them in Redis Store
          • Receive Events via Simulator and Persisting in SOLR Store
          • Receive Data via TCP and Preprocessing'
          • Text Mapping with In-memory Transport
          • Consume Events from a Kafka Topic and Publish to Another Kafka Topic
          • Publish Text Events via Email
          • Publish Emails in XML Format
          • Publish Events to a Google Pub/Sub Topic
          • Publish ER7 Events via HL7
          • Publish XML messages via HL7
          • Publish JSON Events via HTTP
          • Send Custom JSON Events via HTTP
          • Publish XML Events via HTTP
          • Publish Custom XML Events via HTTP
          • Publish HTTP Events to to an OAuth-protected Endpoint
          • Publish HTTP Events to an OAuth-protected Endpoint while Using a Refresh Token Grant Type
          • Publish HTTP Events via an OAuth-protected Endpoint
          • Publish HTTP Events to an OAuth-protected Endpoint
          • Publish HTTP Events to an OAuth-protected Endpoint without an Access Token
          • Publish XML Events via JMS
          • Publish Key-value events via JMS
          • Publish Custom Avro Events via Kafka
          • Publish JSON Events via Kafka
          • Publish Binary Events via Kafka
          • Publish Avro Events via Kafka
          • Publish XML Events via MQTT
          • Publish Consumed Events to Prometheus Metrics and Exposing them via HTTP
          • Publish XML Events via RabbitMQ
          • Publish JSON Events via TCP
          • Publish Text Events via TCP
          • Publish Binary Events via TCP
          • Publish XML Events via WebSocket
          • Send Custom Keyvalue Events via SNMP
          • Aggregate Data Incrementally
          • Receive Email Alerts
          • Receive and Publish Events in Custom CSV Format
          • Publish and Receive CSV Events via Files
          • Preprocess Data Received via TCP
          • Perform Streaming Learning Using a Clustree Model
          • Processe Geo Data
          • Count the Frequency of Values with BottomK
          • Calculate the Distance Between Two Locations
          • Extract Values from a String
          • Make Predictions via Hoeffding Classifier Model
          • Join Streaming Data with Stored Data in RDBMS
          • Insert and Access Data in a Map
          • Round up Amounts via the Math Function
          • Identify Event Patterns Based On Order of Event Arrival
          • Make Predictions via PMML Model
          • Send Custom JSON Events via HTTP
          • Publish Custom XML Events via HTTP
          • Publish Custom Avro Events via Kafka
          • Receive Custom XML Events via HTTP
          • Receive Custom JSON Events via HTTP
          • Receive Custom Text Events via Kafka
          • Receive Custom Text Events via TCP
          • Identify Sub-sequences in Input Sequences
          • Use Javascript Functions in Siddhi Applications
          • Make Predictions via a Streaming Perceptron Model
          • Use StreamingML Kmeans for Clustering
          • Make Predictions via a Regressor Model
          • Convert String Values to Lowercase
          • Receive Data via TCP and Preprocessing
          • Perform Regression Tasks via an Imported Tensorflow Model
          • Text Map with In-memory Transport
          • Convert Units
          • Calculate Aggregations Over Time'
          • Architecture
          • Getting Started Guide
          • Role-based Access Control
          • Alerts
          • Choreo Based Analytics via Proxy
          • ELK Based Analytics Installation Guide
          • Datadog Analytics Installation Guide
        • Publish Analytics Events to External Systems
        • Publish Custom Analytics Events Data
      • Observability Overview
          • Correlation Logs
          • HTTP Access Logs
          • Audit Logs
          • API Logs
          • OpenTracing
          • OpenTelemetry
          • JMX-Based Monitoring
        • Getting Started
          • View General Statistics
          • View ETL Flow Statistics
        • Overview
          • Publisher API v4
          • Developer Portal API v3
          • Admin API v4
          • Gateway API v2
          • Service Catalog API v1
          • DevOps API v0
        • Advanced Configurations
        • Understand the New Configuration Model
        • API-M Config Catalog
      • API Controller (APICTL)
        • Streaming Integrator Connectors Overview
        • Downloading and Install Siddhi Connectors
        • Writing Custom Siddhi Extensions
        • Configure System Parameters for Siddhi Extensions
        • Vendor Specific Extensions
            • Extend Key Validation
            • Extend Scope Validation
            • Extend Key Manager
            • Write Custom Grant Types
            • Customize API Template
            • Write Custom Handlers
            • Invoke the API Manager from the BPEL Engine
            • Customize a Workflow Extension
            • Configure HTTP Redirection for Workflows
            • Configure Workflows for Tenants
            • Configure Workflows in a Cluster
            • Change the Default User Role in Workflows
            • Clean Up Workflow Tasks
            • Configure Single Sign On with SAML2
            • Configure External IDP Through Identity Server for SSO
            • Configure Identity Server as IDP for SSO
            • Multi Factor Authentication for Publisher and Developer Portals
            • Override the Developer Portal Theme
              • API Category based Grouping
              • Change Default View
            • Enable or Disabl API Detail Tabs
            • Override API Overview Page per API
            • Enable or Disable Rating
            • Enable or Disable Home Page
            • Enable or Disable Tag Cloud
            • Enable or Disable Footer
            • Enable or Disable Banner
            • Styling API Details Left Menu
            • Styling API Details Info Section
            • Styling the Logo and Header
            • Enable or Disabling Self Signup
            • Configure reCaptcha for Self-SignUp
          • Override the Publisher Portal Theme
          • Log in to the Developer Portal Using Social Media
          • Directing the Root Context to the Developer Portal
          • Customize User Signup in Developer Portal
          • Customize Login Pages for Developer Portal and Publisher
          • Customize the Developer Portal and Gateway URLs for Tenants
          • Add a User Signup Workflow
          • Add internationalization
          • Define Custom Linter Rules
          • Advanced UI Customization
          • Modify Workflow Approval Task Limit
        • Admin Services
        • Work with the Source Code
        • Java Documentation
        • WSO2 API-M Best Practices
        • Best Practices for Working with Endpoints
      • Accessibility Compliance
        • Message Flow in the API Manager Gateway
        • Accessing API Manager by Multiple Devices Simultaneously
        • admin_Directory Structure of WSO2 Products
        • Error Handling
        • Capturing System Data in Error Situations
        • Troubleshooting in Production Environments
        • Utilizing Runtime Diagnostic Tool
        • Cleaning Up Partially Created Keys
        • Troubleshooting 'Registered callback does not match with the provided url' error
        • Troubleshooting WebSocket APIs
      • FAQ
      • Administer Overview
        • Introduction to User Management
          • Manage User Roles
          • Manage Users
          • Manage Role Permissions
          • Manage Users for Admin Portal
        • Manage Users for the Streaming Integrator
        • Introduction to User Stores
        • Configure Secondary User Stores
        • Write a Custom User Store Manager
        • Configure the Authorization Manager
        • Introduction to Multitenancy
        • Manage Tenants
        • Configure the Tenant Loading Policy
        • Configure Logs
        • Server Health
        • Manage Dashboards
        • Overview
        • Configure WSO2 IS as a Key Manager
        • Configure WSO2 IS 7.x as a Key Manager
        • Configure Keycloak as a Key Manager
        • Configure Okta as a Key Manager
        • Configure Auth0 as a Key Manager
        • Configure PingFederate as A Key Manager
        • Configure ForgeRock as a Key Manager
        • Configure a Custom Key Manager
        • Configure the Global Key Manager
        • Configure the Azure AD as a Key Manager
      • Advanced Configurations
      • Manage Role based access control for the Admin portal
      • Install and Setup Overview
        • Installation Prerequisites
          • Install API-M
          • Run API-M
          • Run API-M as a Linux Service
          • Run API-M as a Windows Service
          • Install SI
          • Install Siddhi Extensions
          • Run SI
          • Run SI as a Windows Service
          • Run SI as a Linux Service
            • Install in Docker
            • Install in Kubernetes
        • Installation Options
          • Update WSO2 API Manager
          • Set up APK as a Gateway
            • Set up a Third-party Key Manager
            • Set up WSO2 Identity Server as a Resident Key Manager
            • Overview
              • Change to MySQL
              • Change to MSSQL
              • Change to PostgreSQL
              • Change to Oracle
              • Change to IBM DB2
              • Change to Oracle RAC
            • Manage Data Growth and Improving Performance
            • Configure the Proxy Server and the Load Balancer
            • Add a custom Proxy Path
              • Maintain Logins and Passwords
                • Customize Secure Vault
                • Set Passwords Using Environment Variables/System Properties
                • Work with Encrypted Passwords
                • Set Up ReCaptcha
                • Configure reCaptcha for Single Sign On
              • Configure Keystores in API Manager
                • Create a New Keystore
                • Renew a CA Signed Certificate
                • About Asymetric Cryptography
            • Enable HostName Verification
            • Enable Java Security Manager
            • General Data Protection Regulation (GDPR) for WSO2 API Manager
            • Configure Transport Level Security
            • User Account Management
            • Secure Web Portals
            • Introduction to User Stores
              • Configure Primary User Stores
              • Configure a JDBC User Store
              • Configure a Read-Write LDAP User Store
              • Configure a Read-Only LDAP User Store
              • Configure a Read-Write Active Directory User Store
            • Configure Identity Server As External IDP with OIDC
            • Configure Identity Server As External IDP with SAML
            • OKTA As An External IDP With OIDC
            • OKTA As An External IDP With SAML
            • Change the Default Transport
            • Configure Caching
            • Customize the Management Console
            • Configure the Crypto Provider
          • Update WSO2 Streaming Integrator
          • Production Checklist
          • Performance Analysis Results
          • Configure Business Rules Deployment
          • Configure Data Sources
            • General Data Protection Regulations
            • Keystores
            • Protect Sensitive Data via the Secure Vault
          • Support For Different Transports
          • Configure State Persistence
          • Configure Cluster Coordination
          • Add Third Party Non OSGi Libraries
          • Configure Default Ports
          • Change the Host Name and Context Path of Web UI Applications
          • Enable Logs for Received Event Count
        • Deployment Patterns Overview
            • All-in-One Deployment Overview
            • Configure a Single API-M Node
            • Configure an Active-Active API-M Deployment
            • Distributed Deployment Overview
            • Configure a Distributed API-M Deployment
            • Configure a Distributed API-M Deployment with Traffic Manager Separation
            • Configure a Distributed API-M Deployment with Key Manager Separation
            • Run the API-M Profiles
            • Multi-DC Deployment Patterns Overview
            • Configure Multi-DC Deployment - Pattern 1
            • Configure Multi-DC Deployment - Pattern 2
          • Streaming Integrator Deployment Overview
          • Single Node Deployment
          • Minimum HA Cluster
          • Active-Active Cluster
          • Scalable Cluster
          • Minimum Ha Cluster in AWS ECS
            • Deploy API-M on K8s Using Helm Resources
          • Deployment Checklist
          • Security Guidelines for a Production Deployment
          • Basic Health Checks
          • Change the Hostname
          • Change the Default Ports
          • Monitor Integration Transaction Counts
          • Backup and Recovery
            • API-M Performance Tuning
          • CI/CD for Integrations - Overview
          • Building a CI/CD Pipeline for Streaming Integrations (K8s deployment)
          • CI/CD for APIs - Overview
          • Build a CI/CD Pipeline for APIs Using the CLI
          • Build a CI/CD Pipeline for APIs using Jenkins
          • Getting Started with WSO2 API Controller (apictl)
            • Manage APIs and API Products
            • Import APIs Via Dev First Approach
            • Migrate APIs to Different Environments
            • Migrate API Products (with or without Dependent APIs) to Different Environments
            • Manage Applications
            • Migrate Apps to Different Environments
            • Manage Rate Limiting Policies
            • Migrate Rate Limiting Policies to Different Environments
            • Manage Common API Policies
            • Migrate Common API Policies to Different Environments
          • Encrypt Secrets with apictl
          • Enable Correlation Logs with apictl
            • Create Custom Users to Perform apictl Operations
            • Configure Environment Specific Parameters
            • Use Dynamic Data in apictl Projects
            • Configure Different Endpoint Types
            • Configuring Different Endpoint Security Types
            • Format the Outputs of Get Commands
            • Configure Git Integration
      • Upgrade
        • Common Runtime and Configuration Artifacts
        • Default Product Ports
        • Product Compatibility
          • API Manager
          • API Manager (Streaming APIs)
          • API Manager (GraphQL APIs)
          • Token Persistence
          • Micro Integrator
        • Supported Cipher Suites
      • Tutorials Overview
        • Scenario Overview
        • Scenario 1 - Create a REST API from an OpenAPI Definition
        • Scenario 2 - Engage Access Control to the API
        • Scenario 3 - Implement an API
        • Scenario 4 - Sign Up a New User
        • Scenario 5 - Get the Developer Community Involved
        • Scenario 6 - Integrate with Data Sources
        • Scenario 7 - Analytics
        • Scenario 8 - Rate Limiting
        • Scenario 9 - Realtime Data with WebSocket API
        • Scenario 10 - Notifications Using WebHooks
        • Scenario 11 - GraphQL Support
        • Scenario 12 - Guaranteed Message Delivery
        • Scenario 13 - Integrate with Services via Connectors
        • Scenario 14 - External Key Manager Support
        • Create and Publish a GraphQL API
          • Create and Publish a WebSocket API
          • Create and Publish a WebSub/WebHook API
          • Create and Publish a SSE API
        • Create and Publish an AWS Lambda API
        • Expose a SOAP Service as a REST API
        • Edit an API by Modifying the API Definition
        • Integrating API Manager with an External Broker and Gateway
        • Tutorials Overview
        • Expose a Kafka Topic as a Managed WebSocket API
        • Perform Real-time ETL with MySQL
        • Perform Real-time ETL with Files
        • Create an ETL Application via Wizard
        • Kafka
        • Integrate Stores
        • Business Rules
        • Expose Processed Data as API
        • Manage Streaming Data with Errors
        • Trigger Integrations via MI
        • Run SI with Docker and Kubernetes

    Back to top
    Previous Developer Portal API v3
    Next Gateway API v2
    WSO2 API Manager - Documentation
    Made with Material for MkDocs
    Copyright © WSO2 LLC 2024
    Content licensed under CC By 4.0. | Sample code licensed under Apache 2.0.