API gateway commands

API gateway mode provides the commands to create or modify an API gateway.

To enter API gateway mode, use the global apigw command. To delete an API gateway, use the no apigw command.

While in this mode, use the commands in the following table to define the API gateway.

  • 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.
Table 1. API gateway commands
Command Purpose
admin-state This command sets the administrative state for the configuration.
assembly-burst-limit This command specifies an assembly burst limit scheme to apply to a rate limit assembly action.
assembly-count-limit This command specifies an assembly count limit scheme to apply to a rate limit assembly action.
assembly-rate-limit This command specifies a rate limit assembly scheme to apply to a rate limit assembly action.
collection This command specifies the list of API collections for the API gateway.
front-persistent-timeout This command sets the inter-transaction timeout for API gateway to client connections.
front-protocol This command assigns a protocol handler to the API gateway.
front-timeout This command sets the intra-transaction timeout for API gateway to client connections.
gateway-service-name This command indicates the gateway service name from API Connect.
loadbalancer-group This command associates a load balancer group with the API gateway.
max-writes This command specifies the maximum concurrent writes that the API gateway allows to the document cache.
maxdocs This command specifies the maximum number of documents that the API gateway can cache.
policy This command defines the caching policy for the API gateway.
proxy This command specifies a proxy policy that associates a set of URLs with a specific HTTP proxy.
share-count This command controls whether the API gateway shares rate-limiting data for all applications.
schedule-rule This command schedules the API gateway to run a specific processing rule.
size This command defines the size of the document cache in bytes for the API gateway.
static-document-calls This command indicates whether multiple calls from the same stylesheet return the same result.
summary This command specifies the brief, descriptive summary for the object instance.
xsl-cache-size This command specifies the maximum number of stylesheets that the API gateway can cache in the stylesheet cache.
xsl-cache-memorysize This command specifies the maximum size for the stylesheet cache of the API gateway.
xsl-checksummed-cache This command controls whether the API gateway caches stylesheets with their SHA1 message digest value.
xslrefresh This command assigns a stylesheet refresh policy to the API gateway.