ApiSubscription Configuration

Weik.io 2026.1

Configure API subscriptions to control access and usage.

On this page

Schema properties
YAML example
Usage notes

Defines a subscription to one or more APIs, controlling access permissions and settings for API consumers.

Schema properties#

Property	Type	Required	Default	Description
Apis	`string[]`	Yes	-	Array of API names that this subscription grants access to
IsActive	`bool`	No	`true`	Whether the subscription is active
Parameters	`Dictionary<string, object>`	No	`{}`	Additional configuration parameters for the subscription
AdditionalHeaders	`Dictionary<string, object>`	No	`{}`	HTTP headers to include in requests made under this subscription
Variables	`Dictionary<string, string>`	No	`{}`	Variables specific to this subscription

YAML example#

apiVersion: weik.io/v1
kind: ApiSubscription
metadata:
  name: partner-subscription
spec:
  Apis:
    - northwind-api
    - products-api
    - orders-api
  IsActive: true
  Parameters:
    RateLimit: 1000
    RateLimitPeriod: hour
    MaxConcurrentRequests: 10
    EnableCaching: true
  AdditionalHeaders:
    X-Partner-Id: partner-123
    X-Request-Source: partner-portal
    X-Environment: production
  Variables:
    SubscriptionTier: premium
    DataCenter: us-east

Usage notes#

Use ApiSubscription configuration to manage access to your APIs. Each subscription can grant access to multiple APIs and can include subscription-specific settings.

The Apis array lists the API names that subscribers can access. Ensure these API names match existing API configurations.

The AdditionalHeaders are automatically included in all requests made under this subscription. Use this to add tracking headers, authentication context, or routing information.

Common parameters include:

RateLimit: Maximum number of requests allowed
RateLimitPeriod: Time period for rate limiting (second, minute, hour, day)
MaxConcurrentRequests: Maximum simultaneous requests
EnableCaching: Whether to cache responses for this subscription

Subscriptions can be deactivated by setting IsActive to false without deleting the configuration.