Skip to main content

API Reference

CLOUD

Complete API reference for the msh Cloud Platform.

Base URL​

All API endpoints are available at:

https://api.msh.io/api/msh

Authentication​

All endpoints require Bearer token authentication:

curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  https://api.msh.io/api/msh/projects/

See API Authentication for details.

Metadata Endpoints​

Upload Context Pack​

POST /metadata/projects/{project_id}/upload

Upload project metadata from CLI or CI/CD.

Get Project Manifest​

GET /metadata/projects/{project_id}/manifest

Retrieve complete project manifest.

Get Asset Metadata​

GET /metadata/assets/{asset_id}/metadata

Retrieve metadata for a specific asset.

Get Asset Lineage​

GET /metadata/assets/{asset_id}/lineage

Retrieve lineage information for an asset.

Get Version History​

GET /metadata/assets/{asset_id}/versions

Retrieve version history for an asset.

Get Test Definitions​

GET /metadata/assets/{asset_id}/tests

Retrieve test definitions and results.

Glossary Endpoints​

Terms​

  • GET /glossary/terms - List terms
  • POST /glossary/terms - Create term
  • GET /glossary/terms/{id} - Get term
  • PUT /glossary/terms/{id} - Update term
  • DELETE /glossary/terms/{id} - Delete term

Metrics​

  • GET /glossary/metrics - List metrics
  • POST /glossary/metrics - Create metric
  • GET /glossary/metrics/{id} - Get metric
  • PUT /glossary/metrics/{id} - Update metric
  • DELETE /glossary/metrics/{id} - Delete metric

Dimensions​

  • GET /glossary/dimensions - List dimensions
  • POST /glossary/dimensions - Create dimension
  • GET /glossary/dimensions/{id} - Get dimension
  • PUT /glossary/dimensions/{id} - Update dimension
  • DELETE /glossary/dimensions/{id} - Delete dimension

Policies​

  • GET /glossary/policies - List policies
  • POST /glossary/policies - Create policy
  • GET /glossary/policies/{id} - Get policy
  • PUT /glossary/policies/{id} - Update policy
  • DELETE /glossary/policies/{id} - Delete policy
  • GET /glossary/links - List links
  • POST /glossary/links - Create link
  • DELETE /glossary/links/{id} - Delete link

Export​

  • GET /glossary/projects/{project_id}/export - Export full glossary

AI Endpoints​

Explain Asset​

POST /ai/explain

Explain what an asset does.

Review Asset​

POST /ai/review

Review asset for risks and issues.

Lineage Impact​

POST /ai/lineage-impact

Analyze downstream impact of changes.

POST /ai/semantic-search

Search using natural language.

Query Console​

POST /ai/query

Translate NL to SQL and execute.

GET /ai/projects/{project_id}/queries

Get query history.

Pre-Deploy Check​

POST /ai/pre-deploy-check

Check deployment safety.

AI Agent​

POST /ai/agent

Chat with AI agent.

Error Handling​

All endpoints return consistent error responses:

{
  "error": "Error message here",
  "details": "Additional error details"
}

Status Codes:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 500 - Internal Server Error

Rate Limiting​

API requests are rate-limited:

  • Free Tier: 100 requests/hour
  • Pro Tier: 1000 requests/hour
  • Enterprise: Unlimited

Rate Limit Headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1642248000