Invoke policy commands
Invoke policy mode provides the commands to create or modify an invoke policy.
To enter the mode, use the global assembly-invoke command. To delete an invoke policy, use the global no assembly-invoke command.
While in this mode, use the commands in the following table to define the invoke policy.
- To view the current configuration, use the show command.
- To restore default values, use the reset command.
- To exit this configuration mode without saving changes to the running configuration, use the cancel command.
- To exit this configuration mode and save changes to the running configuration, use the exit command.
| Command | Purpose |
|---|---|
| admin-state | This command sets the administrative state for the configuration. |
| backend-type | This command specifies the message type of the payload to be sent to the backend. |
| cache-key | This command specifies the string to use as a key for the cache. |
| cache-type | This command specifies how to cache documents. |
| cache-unsafe-response | This command controls whether to cache responses to POST and PUT requests. |
| chunked-uploads | This command controls whether to send documents to the server with
Transfer-Encoding: chunked. |
| collect-data-for-analytics | This command controls whether to collect request and response data for analytics. |
| compression | This command specifies whether to enable HTTP compression. |
| correlation-path | This command specifies the part of the API definition that correlates with the policy. |
| decode-request-params | This command controls whether to decode request parameters that are referenced in the target URL. |
| encode-plus-char | This command controls whether to encode + characters
in query strings. |
| error-types | This command specifies the type of error on which the flow stops. |
| follow-redirects | This command controls the resolution of redirects for the invoke policy. |
| graphql-send-type | This command specifies the type of payload to send for GraphQL POST requests. |
| header-control-list | This command sets the control list that manages whether headers are accepted or rejected. |
| http-version | This command sets the HTTP version that the invoke policy uses to connect to the server. |
| http2-required | This command controls whether the invoke policy requires an HTTP/2 connection to the server. |
| inject-proxy-headers | This command controls whether to inject proxy headers. |
| inject-user-agent | This command controls whether to inject the default
User-Agent header. |
| keep-payload | This command controls whether to include the payload for DELETE requests. |
| method | This command specifies the HTTP method to use for the invocation. |
| output | This command specifies the name of a variable to store the output of the invoke policy. |
| parameter-control-list | This command sets the control list that manages whether URL parameters are accepted or rejected. |
| password | This command specifies the password alias of the user password to use for HTTP basic authentication. |
| persistent-connection | This command controls whether to enable HTTP persistent connections. |
| ssl-client | This command associates a TLS client profile that the invoke policy uses to secure the connection with the target URL. |
| stop-on-error | This command specifies whether the flow stops when a particular type of error occurs during the assembly execution. |
| summary | This command specifies the brief, descriptive summary for the object instance. |
| timeout | This command specifies the duration to wait for a reply from the target. |
| title | This command specifies the title for the configuration. |
| ttl | This command sets the validity period in seconds for documents in the assembly cache. |
| url | This command specifies the URL to call for an invoke policy. |
| username | This command specifies the username for HTTP basic authentication. |