API collection commands
API collection mode provides the commands to create or modify an API collection.
To enter API collection mode, use the global api-collection command. To delete an API collection, use the no api-collection command.
While in this mode, use the commands in the following table to define the API collection.
- 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. |
| analytics-endpoint | This command associates an analytics endpoint configuration to offload analytics data. |
| application-type | This command associates an API application type to the API collection. |
| 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. |
| assembly-postprocessing | This command specifies a postprocessing assembly to run after the assembly rule. |
| assembly-preprocessing | This command specifies a preprocessing assembly to run before the assembly rule. |
| cache-capacity | This command sets the maximum number of subscriber entries that can be cached. |
| catalog-id | This command specifies the ID of the catalog that the API collection corresponds to. |
| catalog-name | This command specifies the name of the catalog that the API collection corresponds to. |
| default-rate-limit | This command defines the default rate limit scheme for the collection. |
| dev-portal-endpoint | This command specifies the URL of the Developer Portal endpoint. |
| enable-api-mutual-tls | This command controls whether to make mutual TLS protection available for APIs in this collection. |
| enforce-pre-assembly-rate-limits | This command specifies whether to enforce the API rate limits and burst limits that are defined in the API plan. |
| error-rule | This command associates an API error rule. |
| organization-id | This command specifies the ID for the organization that the API collection belongs to. |
| organization-name | This command specifies the name for the organization that the API collection belongs to. |
| plan | This command associates the list of plans that are available in the API collection. |
| parse-settings-reference | This command specifies the parse settings configuration for the API collection. |
| processing-rule | This command associates an API processing rule. |
| routing-prefix | This command adds a routing prefix for the API collection. |
| sandbox | This command indicates whether the API collection is a sandbox or for production. |
| summary | This command specifies the brief, descriptive summary for the object instance. |