# 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 <support@decube.io>.

## Getting Started

Follow these steps to start integrating with Decube APIs:

1. [Generate your API Key](https://docs.decube.io/api-keys#generating-api-keys)
2. Try your first API call (see example below)
3. Explore the [API Reference](#structure) for available endpoints

Need some ideas on how to use the API? Check out our [use cases](https://docs.decube.io/public-api/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

1. Log in to your Decube account.
2. Navigate to "My Account" > "Update Profile".
3. Click "Generate New API Key".
4. Use the API key in the `X-Decube-Api-Key` header for all requests. See [how to generate API keys](https://docs.decube.io/api-keys#generating-api-keys).

### First API Call Example

```bash
curl -H "X-Decube-Api-Key: YOUR_API_KEY" \
  https://connect.<REGION>.decube.io/api/v1/data/catalog/glossary/list
```

**Note:** 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](#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](#data-api)
* **Control API**: Manage users within your organization. [See Control API Reference](#control-api)

### 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 <support@decube.io>. We also welcome feedback and suggestions to improve our API and documentation.