Skip to main content

APIs

An API in the Control Plane represents a set of resources made available to consumers, both internally and externally. Each API operates under a formal contract — its specification — which outlines available resources, operations, and authentication requirements. As your APIs mature, their specifications evolve through multiple versions, all managed in one place.

APIs can be registered manually, imported from specification files, synced from Git repositories, or discovered automatically from connected gateways. Once registered, they can be governed with rule sets, bundled into API Products for subscription, and deployed to any number of environments.

Key concepts​

  • API — A named API resource with metadata, ownership, tags, and a gateway platform type
  • API Version — A specific version of an API (e.g., 1.0.0, 2.0.0), each with its own specification. Multiple versions can coexist and be deployed independently, enabling rolling upgrades and rollback capabilities
  • API Specification — The OpenAPI, AsyncAPI, GraphQL, or Protocol Buffers file attached to a version. Specs are automatically validated and scored against governance rule sets
  • Documentation Pages — Custom Markdown or HTML documentation pages attached to an API, providing guides and context beyond the spec
  • Deployment — Publishing an API to one or more environments via their connected gateways

API status​

StatusDescription
ACTIVEThe API is active and available
INACTIVEThe API is disabled

Platform types​

APIs can be associated with different gateway platforms:

UNKNOWN, APIGEE, GRAVITEE, LAYER7, AWS, AZURE, KONG, WSO2, AAGM, IBM, BOOMI, MULESOFT, CAM, UNIVERSAL

Deployment status​

StatusDescription
CREATEDNot yet deployed
DEPLOYMENT_REQUIREDChanges require redeployment
DEPLOYMENT_IN_PROGRESSDeployment is running
DEPLOYEDSuccessfully deployed
DEPLOYMENT_FAILEDDeployment encountered an error
DELETION_IN_PROGRESSBeing removed from environment
DELETION_FAILEDRemoval encountered an error