Overview
Welcome to the Decube Public API! This documentation will help you get up and running quickly with our platform.
This API is currently in BETA and subject to ongoing development. Functionality and structure may evolve as we continue to refine and enhance the service. We welcome your feedback and encourage you to report issues or suggestions to the Decube team at [email protected].
Getting Started
Follow these steps to start integrating with Decube APIs:
Try your first API call (see example below)
Explore the API Reference for available endpoints
Need some ideas on how to use the API? Check out our use cases for inspiration.
Common Use Cases
Build a data catalog
Automate glossary management
Track data lineage
Manage user access and permissions
How to Authenticate
Log in to your Decube account.
Navigate to "My Account" > "Update Profile".
Click "Generate New API Key".
Use the API key in the
X-Decube-Api-Keyheader for all requests. See how to generate API keys.
First API Call Example
curl -H "X-Decube-Api-Key: YOUR_API_KEY" \
https://connect.<REGION>.decube.io/api/v1/data/catalog/glossary/listNote: Replace <REGION> with your specific Decube region (e.g., us-1, apac). You can find the region name in your URL bar when logged into Decube (e.g., https://apac.decube.io).
If you receive an error, check your API key and region. For more details on error codes and troubleshooting, see the Support section below.
Structure
Decube provides two main API groups:
Data API: Manage and query your data assets, glossary, and lineage. Also allows you to manage access control for groups. See Data API Reference
Control API: Manage users within your organization. See Control API Reference
Data API
These are APIs related to interacting with data within a customer's Data Plane, such as assets, glossary, and lineage.
Control API
These are APIs related to interacting with data within the Decube Control Plane, such as user management.
Versioning
Current API version is V1 which is a BETA version. This endpoint WILL be deprecated and moved to V2 once it is available for General Availability.
Rate Limit
Currently, no hard limit is enforced. Rate limit WILL be enforced in the future.
Support
If you have questions, encounter issues, or need help integrating with the Decube API, please contact our team at [email protected]. We also welcome feedback and suggestions to improve our API and documentation.
Last updated