api

<api name="string"
	 port="integer"
	 method="[*,POST,PUT,GET,DELETE,TRACE,OPTIONS]"
	 host="[string,*]"
	 ip="[ip]">
  <path />?
  <ssl />?
  <request>
    [interceptors]*
  </request>
    [interceptors]*
  <response>
    [interceptors]*
  </response>
  <localhost />?
  <target />?
</api>

<api port="2000">
  <target url="https://api.predic8.de"/>
</api>

Simple forwarding API from port 2000 to https://api.predic8.de

<api port="2000">
  <openapi location="fruitshop-api-v1.oas.yaml"/>
</api>

API from OpenAPI YAML file

Name	Required	Default	Description	Examples
method	false	*	If set, Membrane will only consider this rule, if the method (GET, PUT, POST, DELETE, etc.) header of incoming HTTP requests matches. The asterisk '*' matches any method.	GET
test	false	-	-	-
port	false	80	The port Membrane listens on for incoming connections.	8080
ip	false	not set	If present, binds the port only on the specified IP. Useful for hosts with multiple IP addresses.	127.0.0.1
name	false	By default, a name will be automatically generated from the target host, port, etc.	The name as shown in the Admin Console.	-
host	false	not set	A space separated list of hostnames. If set, Membrane will only consider this rule, if the "Host" header of incoming HTTP requests matches one of the hostnames. The asterisk '*' can be used for basic globbing (to match any number, including zero, characters).	predic8.de *.predic8.de
language	false	-	-	-

Elements	Description	Cardinality
description		0..1
openapi	Deploys an API from an OpenAPI document.	0..*
path	If set, Membrane will only consider this rule, if the path of incoming HTTP requests matches. {@link Path} supports starts-with and regex matching. If used in a {@link SOAPProxy}, this causes path rewriting of SOAP requests and in the WSDL to automatically be configured.	0..1
ssl	Configures the usage of inbound SSL (HTTPS).	0..1
jwtAuth		0..*
apiKey		0..*
limit		0..*
ruleMatching		0..*
index		0..*
apiDocs		0..*
abort		0..*
webServer		0..*
flowInitiator		0..*
static		0..*
openTelemetry		0..*
chain		0..*
shadowing		0..*
greaser		0..*
for		0..*
oauth2Resource2		0..*
shutdown		0..*
clusterNotification		0..*
template		0..*
analyser		0..*
exchangeStore		0..*
webSocket		0..*
if		0..*
xenAuthentication		0..*
accountRegistration		0..*
jsonProtection		0..*
testService		0..*
ntlm		0..*
counter		0..*
formValidation		0..*
groovyTemplate		0..*
acmeHttpChallenge		0..*
webServiceExplorer		0..*
internalRouting		0..*
groovy		0..*
transform		0..*
soapBody		0..*
tcp		0..*
httpClient		0..*
destination		0..*
headerFilter		0..*
validator		0..*
soapStackTraceFilter		0..*
xml2Json		0..*
xmlContentFilter		0..*
time		0..*
accessLog		0..*
wadlRewriter		0..*
beautifier		0..*
wsdlPublisher		0..*
rateLimiter		0..*
regExReplacer		0..*
logContext		0..*
http2xml		0..*
graphQLProtection		0..*
call		0..*
tokenValidator		0..*
response		0..*
replace		0..*
setHeader		0..*
accessControl		0..*
soapOperationExtractor		0..*
xmlProtection		0..*
balancer		0..*
echo		0..*
wsaEndpointRewriter		0..*
throttle		0..*
oauth2PermissionChecker		0..*
statisticsProvider		0..*
rewriter		0..*
methodOverride		0..*
statisticsCSV		0..*
statisticsJDBC		0..*
requireAuth		0..*
interceptor		0..*
idempotency		0..*
log		0..*
authHead2Body		0..*
rest2Soap		0..*
cache		0..*
clamav		0..*
adminConsole		0..*
javascript		0..*
choose		0..*
openapiValidator		0..*
request		0..*
openapiPublisher		0..*
json2Xml		0..*
basicAuthentication		0..*
setProperty		0..*
global		0..*
kubernetesValidation		0..*
return		0..*
wsdlRewriter		0..*
reverseProxying		0..*
userFeature		0..*
setCookies		0..*
sampleSoapService		0..*
stompClient		0..*
urlNormalizer		0..*
soap2Rest		0..*
APIsJSON		0..*
login		0..*
oauth2authserver		0..*
dispatching		0..*
paddingHeader		0..*
adminApi		0..*
jwtSign		0..*
cors		0..*
prometheus		0..*
target		0..1

Can be used in:

Syntax

Sample

Attributes

Child Elements

Other optional Child Elements