This documentation is for WSO2 API Manager 1.4.0 View documentation for the latest release.
Page Comparison - Configuring api-manager.xml (v.5 vs v.6) - API Manager 1.4.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Note
titleNote

This page is still under construction.

Users can change the default API Manager-specific configurations by editing api-manager.xml file using the information given below.

File Details

  • File Name: api-manager.xml
  • Location: $CARBON_HOME\repository\conf
  • Purpose: Store all API Manager functionality related configurations.

XML Elements
Anchor
elements
elements

 Click on a main element to view its details along with specifics on its sub elements.

  • <APIManager>
  •        <DataSourceName>
  •        <Database>
  •                <URL>
  •                <Username>
  •                <Password>
  •                <Driver>
  •        <AuthManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •        <APIConsumerAuthentication>

  •                <SecurityContextHeader>

  •                <ClaimsRetrieverImplClass>

  •                <ConsumerDialectURI>

  •                <SignatureAlgorithm>

  •                <EnableTokenGeneration>
  •        <APIGateway>
  •                <ServerURL>

  •                <Username>

  •                <Password>

  •                <APIEndpointURL>
  •                <EnableGatewayKeyCache>
  •        <APIUsageTracking>

  •                <Enabled>

  •                <PublisherClass>

  •                <ThriftPort>

  •                <BAMServerURL>

  •                <BAMUsername>

  •                <BAMPassword>

  •                <DataSourceName>

  •       <APIKeyManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •                <EnableJWTCache>

  •               <EnableKeyMgtValidationInfoCache>

  •               <KeyValidatorClientType>

  •               <ThriftClientPort>

  •               <ThriftClientConnectionTimeOut>

  •               <ThriftServerPort>

  •               <RemoveUserNameToJWTForApplicationToken>

  •       <TierManagement>

  •               <EnableUnlimitedTier>

  •       <SelfSignUp>

  •               <Enabled>

  •               <SubscriberRoleName>

  •               <CreateSubscriberRole>

  •       <APIStore>

  •               <DisplayMultipleVersions>

  •               <DisplayAllAPIs>

  •               <DisplayComments>

  •               <DisplayRatings>

  •       <StatusObservers>

  •               <Observer>


<APIManager>
Anchor
APIManager
APIManager

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sample Implementations


Back to Top ^


 <DataSourceName> 
Anchor
DataSourceName
DataSourceName

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 

 

Sample Implementations


Back to Top ^


<Database>
Anchor
Database
Database

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<URL>      
<Username>      

<Password>

      

<Driver>

      
 
Sample Implementations

Back to Top ^


 <AuthManager> 
Anchor
AuthManager
AuthManager

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
 
Sample Implementations

Back to Top ^


<APIConsumerAuthentication> 
Anchor
APIConsumerAuthentication
APIConsumerAuthentication

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<SecurityContextHeader>      
<ClaimsRetrieverImplClass>      

<ConsumerDialectURI>

      
<SignatureAlgorithm>      
<EnableTokenGeneration>      
Sample Implementations

Back to Top ^


<APIGateway>
Anchor
APIGateway
APIGateway

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
<APIEndpointURL>      
<EnableGatewayKeyCache>      
 
Sample Implementations

Back to Top ^


<APIUsageTracking> 
Anchor
APIUsageTracking
APIUsageTracking

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Enabled>      
<PublisherClass>      

<ThriftPort>

      
<BAMServerURL>      
<BAMUsername>      
<BAMPassword>      

<DataSourceName>

      
 
Sample Implementations

Back to Top ^


<APIKeyManager> 
Anchor
APIKeyManager
APIKeyManager

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
<EnableJWTCache>      
<EnableKeyMgtValidationInfoCache>      
<KeyValidatorClientType>      

<ThriftClientPort>

      
<ThriftClientConnectionTimeOut>      
<ThriftServerPort>      
<RemoveUserNameToJWTForApplicationToken>      
 
Sample Implementations

Back to Top ^


<TierManagement> 
Anchor
TierManagement
TierManagement

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<EnableUnlimitedTier>      
 
Sample Implementations

Back to Top ^


<SelfSignUp> 
Anchor
SelfSignUp
SelfSignUp

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Enabled>      
<SubscriberRoleName>      

<CreateSubscriberRole>

      
 
Sample Implementations

Back to Top ^


<APIStore> 
Anchor
APIStore
APIStore

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<DisplayMultipleVersions>      
<DisplayAllAPIs>      

<DisplayComments>

      
<DisplayRatings>      
 
Sample Implementations

Back to Top ^


<StatusObservers> 
Anchor
StatusObservers
StatusObservers

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Observer>      
 
Sample Implementations

<ExtensionHandlerPosition>

When an API is invoked, a list of handlers gets engaged to its execution flow. The Extension Handler by default is the last handler in the execution flow. This attribute enables configuring its position. 

Supported values: top, bottom

Defaults to: bottom

Back to Top ^

Excerpt
hiddentrue

Instructions to configure api-manager.xml file in WSO2 API Manager. Through this file, users can change the default configurations according to their requirements.