Skip to main content

​
Overview

Collections in KnoxCall are organizational containers that help you group related routes, secrets, and variables together. They provide a structured way to manage shared configurations across multiple routes and maintain consistency in your API proxy setup.

​
Key Features

​
Route Organization

Group related routes together for better project management. All routes in a collection can share common settings and configurations.

​
Shared Variables

Define variables once and use them across all routes in the collection. Variables can be:
  • Static values - Reusable configuration values
  • Secret references - Point to encrypted secrets for sensitive data

​
Environment Defaults

Set default configurations per environment that apply to all routes in the collection:
  • Base URLs - Default target URLs for each environment
  • Default Clients - Automatically attach authorized clients to routes
  • Expected Environments - Auto-provision routes with specific environments

​
Centralized Secret Management

Attach secrets to a collection and reference them across all routes, ensuring consistent credential management.

​
Use Cases

Group routes for different microservices (auth, payments, notifications) in separate collections, each with their own secrets and environment configurations.
Create collections per client or tenant, with isolated credentials and configuration variables.
Define different base URLs and client permissions per environment (dev, staging, production) at the collection level.
Organize routes by team or project area, making it easier for different teams to manage their own API integrations.

​
How Collections Work

When you create a collection, you can:
  1. Add Routes - Assign existing routes or create new ones directly in the collection
  2. Define Variables - Create reusable key-value pairs or secret references
  3. Configure Environments - Set base URLs and default clients per environment
  4. Attach Secrets - Move secrets into the collection for shared access
  5. Apply Defaults - Bulk-apply environment configurations to all routes
Routes in a collection can reference collection variables using the syntax: 
{{var:variable_name}}

​
Benefits

Consistency

Ensure all related routes use the same credentials and configurations

Scalability

Easily add new routes that inherit collection settings

Maintainability

Update shared variables and secrets in one place

Environment Management

Streamline multi-environment deployments with collection defaults

​
Next Steps

Managing Collections

Learn how to create and manage collections

Collection Variables

Work with variables and secret references