Meshery Schemas

API Reference

Browse the full Meshery REST API from bundled OpenAPI specifications in this repository.

Meshery Server API

Endpoints for the open-source Meshery Server — designs, components, models, relationships, connections, and more.

meshery_openapi.yml

Layer5 Cloud API

Endpoints for Layer5 Cloud — identity, entitlements, teams, subscriptions, and cloud-specific operations.

cloud_openapi.yml

How API Docs Are Generated

The API documentation is generated automatically from the same schema sources used for code generation:

  1. Per-construct api.yml files define all endpoints
  2. make bundle-openapi merges them into unified specs
  3. The x-internal annotation controls which spec includes each path:
    • x-internal: ["cloud"] → cloud_openapi.yml only
    • x-internal: ["meshery"] → meshery_openapi.yml only
    • No annotation → included in both

Endpoint Categories

Category Prefix Domain
Identity /api/identity/ Users, orgs, roles, teams, invitations
Integrations /api/integrations/ Connections, environments, credentials
Content /api/content/ Designs, views, components, models
Entitlement /api/entitlement/ Plans, subscriptions, features
Auth /api/auth/ Tokens, keychains, keys

Regenerating Docs Locally

# Generate the bundled OpenAPI specs
make bundle-openapi

# The specs are output to:
#   _openapi_build/meshery_openapi.yml
#   _openapi_build/cloud_openapi.yml

You can then open these files in any OpenAPI viewer.