Skip to main content

Subscriptions

Subscriptions define access for an Application to connect to a specific API Product.

Create a Subscription

From an Application's Subscriptions tab, select Subscribe to API Product and provide:

  • API Product: the API Product to connect with, chosen from the catalog of published products.
  • Subscription Name: a descriptive name for this subscription.
  • API Product Version: the version of the chosen API Product.
  • Description (optional): additional context or notes.
  • Access Type:
    • API Consumer: read-only access to the product's operations, consume messages, receive events.
    • API Provider: full access to all topics for this API Product, able to produce and consume; requires producer-level permissions.
Subscribe to API Product dialog with product, name, version, description, and access type fields
Subscribe to API Product dialog with product, name, version, description, and access type fields

Select Create Subscription to finalize. The new subscription starts in whatever state the product's plan requires: Approved immediately under automatic approval, or Pending if it needs manual approval first.