| authenticate |
Yes |
object |
Authenticate request based on extracted identity |
| authorize |
Yes |
object |
Authorize access for an authenticated request |
| azureOpenAiChatCompletions |
Yes |
object |
API Endpoint call for Azure Open AI backend server, POST Chat Completions URI |
| azureOpenAiEmbeddings |
Yes |
object |
API Endpoint call for Azure Open AI backend server, POST Embeddings URI |
| azureOpenAiModels |
Yes |
object |
API Endpoint call for Azure Open AI backend server, GET Models URI |
| azureOpenAiModelsId |
Yes |
object |
API Endpoint call for Azure Open AI backend server, GET Models/{model_id} URI |
| block |
Yes |
object |
Block a request based on configured criteria |
| cache |
Yes |
object |
Cache policy allows a user to cache complex results whether it be from remote sources or
expensive local calculations. |
| circuitBreaker |
Yes |
object |
Run an execute, count concurrency or failures. If limits are exceeded then run a fallback
execute |
| setAuthorization |
Yes |
object |
Sets the Authorization header |
| cors |
Yes |
object |
Configure gateway support for CORS (Cross-Origin Resource Sharing) |
| countLimit |
Yes |
object |
Enforce simultaneous access to resources |
| extractIdentity |
Yes |
object |
Extract the identity |
| handlebarsTemplate |
Yes |
object |
Generate String value or payload using Handlerbars template |
| ibmCloudLogin |
Yes |
object |
Login to IBM Cloud using pre-configured credentials |
| if |
Yes |
object |
Run an execute block if a condition is met |
| invoke |
Yes |
object |
Call an external endpoint (Currently Http(s)) |
| invokeAwsLambda |
Yes |
object |
Invoke AWS lambda function |
| loadBalancer |
Yes |
object |
Distribute traffic across multiple endpoints |
| luaScript |
Yes |
object |
Run LuaScript code |
| openAiChatCompletions |
Yes |
object |
API Endpoint call for Open AI backend server, POST Chat Completions URI |
| openAiEmbeddings |
Yes |
object |
API Endpoint call for Open AI backend server, POST Embeddings URI |
| openAiModels |
Yes |
object |
API Endpoint call for Open AI backend server, GET Models URI |
| openAiModelsId |
Yes |
object |
API Endpoint call for Open AI backend server, GET Models/{model_id} URI |
| operationSwitch |
Yes |
object |
Execute a series of policies conditioned on API path and/or verb |
| or |
Yes |
object |
Run a single action or an execute, if it fails run the next in a list until success |
| parse |
Yes |
object |
Parse the payload of a message |
| rateLimit |
Yes |
object |
Limit the rate of access to a specified resource |
| retryIterator |
Yes |
object |
Run an execute block, catch specified errors and retry up to a specified number of times the
same execute block |
| return |
Yes |
object |
Complete execution of an assembly earlier with the success result |
| redact |
Yes |
object |
Redact message payload, header, variable, query parameters, and telemetry |
| remove |
Yes |
object |
Remove message payload, header, variable, query parameters, and telemetry |
| set |
Yes |
object |
Set specified fields on the Assembly Context |
| sqlInjectionFilter |
Yes |
object |
Scans payload and/or URI for SQL injection attacks |
| transform |
Yes |
object |
Transform message payload, header, variable, uri, and telemetry |
| switch |
Yes |
object |
Run the first assembly that matched the given expressions |
| throw |
Yes |
object |
Complete execution of an assembly with an error result |
| try |
Yes |
object |
Create a block of assembly actions, containing catch block to handle errors during their
execution and finally to unconditionally execute actions after the block |
| userDefined |
Yes |
object |
Call into an assembly defined as a separate ConfigMap |
| validate |
Yes |
object |
Validate request |
| watsonxModels |
Yes |
object |
API Endpoint call for Watson X backend server, GET Models URI |
| watsonxTextGen |
Yes |
object |
API Endpoint call for Watson X backend server, POST Text Generation URI |
| watsonxTokenize |
Yes |
object |
API Endpoint call for Watson X backend server, POST Tokenize URI |
| geminiModels |
Yes |
object |
API Endpoint call for Gemini backend server, GET Models URI |
| geminiModelsId |
Yes |
object |
API Endpoint call for Gemini backend server, POST Generate Content URI |
| geminiGenerateContent |
Yes |
object |
API Endpoint call for Gemini backend server, POST Generate Content URI |
| geminiEmbedContent |
Yes |
object |
API Endpoint call for Gemini backend server, POST Batch Embeddings URI |
| geminiBatchEmbedContents |
Yes |
object |
API Endpoint call for Gemini backend server, POST Batch Embeddings URI |
| geminiCountTokens |
Yes |
object |
API Endpoint call for Gemini backend server, POST Count Tokens URI |
| telemetry |
No |
object |
Defines custom telemetry attributes for the cache operation |
| tittle |
No |
string or null |
Specifies a custom title for the cache operation |