api-reference

API Reference

Cloudthread provides a powerful and flexible REST Developer API to help you get the most out of your data.

These docs show how to use the API, and what features are currently available.

{% hint style="info" %} Good to know: All the API methods referenced in the docs are synced to a Swagger file URL (OpenAPI v3) and are kept up to date automatically with changes to the API. {% endhint %}

Basic setup

Cloudthread's Developer API lives at:

{% embed url="https://api.cloudthread.io" fullWidth="false" %}

{% hint style="warning" %} Cloudthread requires an API Token to process incoming developer API requests.

Admin's have the ability to generate API Tokens on the Cloudthread platform within the Settings tab. {% endhint %}

This API Token should be included in the headers for all Developer API requests as follows:

x-api-key: {API_TOKEN}

{% hint style="danger" %} Any request without a valid token will be rejected. {% endhint %}

Custom Data ingestion

Cloudthread provides the ability to send custom data to our systems that can then be used in your Cost Views and Unit Metrics.

In order to send custom data, you must provision a Custom Data - Data Stream Token on the Cloudthread platform within the Settings tab.

{% content-ref url="custom_data.md" %} custom_data.md {% endcontent-ref %}

Data sent via this API will appear in Costs Overview and Unit Metrics Lab on Cloudthread's platform.

Event Overlay ingestion

Cloudthread provides the ability to send webhook events that can be overlayed on top of your Cost Views and Unit Metrics. See Events Overlay for more details.

{% content-ref url="events.md" %} events.md {% endcontent-ref %}

Data sent via this API will appear in Costs Overview and Unit Metrics Lab on Cloudthread's platform.

Tag Catalog fetch

Cloudthread provides the ability to fetch a Tags Catalog entry via catalog key.

{% content-ref url="tag_catalog.md" %} tag_catalog.md {% endcontent-ref %}

Cost View and Unit Metric Data fetch

Cloudthread provides the ability to fetch Cost Views and Unit Metrics data.

{% content-ref url="metrics.md" %} metrics.md {% endcontent-ref %}

Users and Teams setup

API can be used to set up and change Users (see User Management) and Teams.

{% content-ref url="users.md" %} users.md {% endcontent-ref %}

{% content-ref url="teams.md" %} teams.md {% endcontent-ref %}

Savings Hub manipulation

API to retrive and setup Savings Opportunities and Savings Threads.

{% content-ref url="savings-hub/" %} savings-hub {% endcontent-ref %}