The Labels API allows you to programmatically manage and apply custom metadata to your DoiT Cloud Intelligence™ resources. By defining and assigning labels, you can organize your cloud governance objects—such as budgets, allocations, and reports—to better align with your organization's team structure, cost centers, or environments.
Overview
Labels in the DoiT Platform serve as a powerful organization layer. Unlike cloud provider tags (which often consist of distinct key-value pairs), DoiT Labels are single-value identifiers (e.g., Production, Engineering, CostCenter-123). This simple, flat taxonomy enables you to categorize and filter your FinOps and governance resources within the DoiT Console and via the API without managing complex key-value hierarchies.
Use the Labels API to:
- Centralize Management: Create a standard library of labels (e.g.,
Production,DevOps) to be used across your organization. - Improve Governance: Tag Budgets and Allocations to ensure they are tracked against the correct business units.
- Automate Categorization: Automatically apply labels to new Reports or Alerts as part of your provisioning workflows.
Key Capabilities
The Labels API is designed around a centralized label management model. You create a label once and then assign it to multiple supported objects.
- Create and Manage Labels: Define new labels with a unique key/name and an optional description.
- Assign to Objects: Bulk assign or unassign these labels to various DoiT resources.
- Filter and Retrieve: List all available labels to audit your organization's taxonomy.
Supported Resources
You can currently assign labels to the following objects:
- Allocations
- Budgets
- Reports
- Alerts
- Metrics
- Annotations
API Reference
Explore the endpoints below to integrate Labels into your workflows:
| Operation | Endpoint | Description |
|---|---|---|
| List Labels | GET /labels | Retrieve a list of all labels available in your account. |
| Create Label | POST /labels | Create a new label definition. |
| Get Label | GET /labels/{id} | Retrieve details for a specific label by its ID. |
| Update Label | PATCH /labels/{id} | Modify an existing label's name or description. |
| Delete Label | DELETE /labels/{id} | Remove a label permanently. |
| Assign Objects | POST /labels/{id}/assignments | Assign or remove the label from specific objects. |
