Ana içeriğe atla

​
Response Status

​
EnumStatus

Response status values used in all API responses.
ValueDescription
SUCCESSOperation completed successfully
FAILUREOperation failed

​
Usage

All API responses include a status field with one of these values.

​
Example

{
  "status": "SUCCESS",
  "resultList": [...],
  "resultCount": 1
}

​
API Types

​
EnumApiType

Type of API Proxy.
ValueDescription
RESTRESTful API
SOAPSOAP Web Service
GRPCgRPC Service
WEBSOCKETWebSocket Service

​
Usage

Used in API Proxy objects to indicate the API type.

​
HTTP Methods

​
EnumHttpRequestMethod

HTTP request methods supported by the API.
ValueDescription
GETRetrieve resource
POSTCreate resource or submit data
PUTUpdate resource (full replacement)
PATCHUpdate resource (partial update)
DELETEDelete resource
HEADRetrieve headers only
OPTIONSRetrieve allowed methods
TRACEEcho request for debugging
ALLAll HTTP methods

​
Usage

Used in endpoint definitions, client routes, and policy target specifications.

​
Policy Scope

​
EnumPolicyTargetScope

Scope where a policy applies.
ValueDescription
ALLPolicy applies to all endpoints in the API Proxy
ENDPOINTPolicy applies only to a specific endpoint

​
Usage

Used in policy operation metadata (operationMetadata.targetScope). Note: When targetScope is ENDPOINT, both targetEndpoint and targetEndpointHTTPMethod must be provided.

​
Policy Pipeline

​
EnumPolicyTargetPipeline

Pipeline where a policy executes.
ValueDescription
REQUESTExecutes before forwarding request to backend
RESPONSEExecutes after receiving response from backend
ERRORExecutes when an error occurs

​
Usage

Used in policy operation metadata (operationMetadata.targetPipeline).

​
Access Type

​
EnumAccessType

Type of resource that can be accessed.
ValueDescription
API_PROXYAPI Proxy resource
API_PROXY_GROUPAPI Proxy Group resource

​
Usage

Used in credential access management to specify which type of resource access is granted.

​
Variable Types

​
EnumVariableType

Type of variable used in policies and conditions.
ValueDescription
HEADERExtract value from HTTP header
PARAMETERExtract value from URL parameter (query, path, or form)
BODYExtract value from request/response body
CONTEXT_VALUESExtract value from context (e.g., current time, IP address)
CUSTOMCustom variable defined with script

​
Usage

Used in VariableDTO to specify how to extract data. See Variable Definition for complete documentation.

​
Variable Parameter Types

​
EnumVariableParameterType

Type of parameter when VariableDTO.type is PARAMETER.
ValueDescription
QUERYQuery parameter (e.g., ?param=value)
PATHPath parameter (e.g., /users/{id})
FORMForm parameter (from form data)

​
Usage

Used in VariableDTO.paramType when type is PARAMETER.

​
Message Content Types

​
EnumMessageContentType

Content type of message body.
ValueDescription
JSONJSON format
XMLXML format
FORMForm data format

​
Usage

Used in VariableDTO.messageContentType when extracting data from body (type=BODY).

​
Script Types

​
EnumScriptType

Script language for custom variables and script policies.
ValueDescription
GROOVYGroovy script
JAVASCRIPTJavaScript (Nashorn) script

​
Usage

Used in VariableDTO.scriptLanguage and script-based policies.

​
API Proxy Spec Types

​
EnumApiProxySpecType

Type of API specification used to create an API Proxy.
ValueDescription
WSDLWSDL (Web Services Description Language) for SOAP APIs
SWAGGERSwagger 2.0 specification
OPEN_APIOpenAPI 3.0 specification
REVERSE_PROXYReverse proxy (no specification file)

​
Usage

Used when importing or creating API Proxies from specification files.

​
Condition Value Comparison Operators

​
EnumConditionValueComparisonOperator

Comparison operators used in policy conditions and RLCL conditions for value comparisons.
ValueDescription
LTLess than
LELess than or equal to
GTGreater than
GEGreater than or equal to
EQEqual to
NENot equal to
STARTS_WITHStarts with (string only)
ENDS_WITHEnds with (string only)
CONTAINSContains (string only)
NOT_CONTAINSDoes not contain (string only)
IS_EMPTYValue exists and is empty
IS_NOT_EMPTYValue exists and is not empty
IS_EXISTSValue exists
IS_NOT_EXISTSValue does not exist
INValue is in list
NOT_INValue is not in list

​
Usage

Used in ConditionRuleDTO.valueComparisonOperator for policy conditions and RLCL conditions to specify how values should be compared. Note:
  • Numeric operators (LT, LE, GT, GE, EQ, NE) work with numeric data types.
  • String operators (STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS) work with string data types only.
  • Existence operators (IS_EMPTY, IS_NOT_EMPTY, IS_EXISTS, IS_NOT_EXISTS) check for value existence and emptiness.
  • List operators (IN, NOT_IN) check if a value is present in a list.