Costfluent Docs
  • Documentation
  • API Reference
Information
Workspaces
    List workspacesgetCreate workspacepostGet workspacegetUpdate workspaceputDelete workspacedeleteGet the workspace's exchange rate policyget
Virtual Tags
    Activate virtual tagpostList virtual tagsgetCreate virtual tagpostDeactivate virtual tagpostGet virtual taggetDelete virtual tagdeleteUpdate virtual tagpatch
Virtual-Tags
    Activate virtual tagpostList virtual tagsgetCreate virtual tagpostDeactivate virtual tagpostGet virtual taggetDelete virtual tagdeleteUpdate virtual tagpatch
Utility
    Get current token infogetHealth checkget
Me
    Get current token infoget
Ping
    Health checkget
Tags
    Get tag keygetDelete tag keydeleteList tag keysget
Tag-Keys
    Get tag keygetDelete tag keydeleteList tag keysget
Saved Filters
    List saved filtersgetCreate saved filterpostGet saved filtergetUpdate saved filterputDelete saved filterdelete
Saved-Filters
    List saved filtersgetCreate saved filterpostGet saved filtergetUpdate saved filterputDelete saved filterdelete
Providers
    List providersgetConnect providerpostGet providergetDelete providerdeleteGet available providersgetGet provider sync historygetTest provider connectionpostTrigger provider syncpostUpdate providerput
Folders
    List foldersgetCreate folderpostGet foldergetUpdate folderputDelete folderdelete
Exchange Rates
    Get available currenciesgetGet exchange rategetGet the workspace's exchange rate policygetList exchange ratesget
Exchange-Rates
    Get available currenciesgetGet exchange rategetList exchange ratesget
Dashboards
    List dashboardsgetCreate dashboardpostGet dashboardgetUpdate dashboardputDelete dashboarddelete
Custom Provider
    Submit costs batchpost
Custom-Providers
    Submit costs batchpost
Report Notifications
    Activate report notificationpostList report notificationsgetCreate report notificationpostDeactivate report notificationpostGet report notificationgetDelete report notificationdeleteUpdate report notificationpatch
Cost-Report-Subscriptions
    Activate report notificationpostList report notificationsgetCreate report notificationpostDeactivate report notificationpostGet report notificationgetDelete report notificationdeleteUpdate report notificationpatch
Cost Reports
    List cost reportsgetCreate cost reportpostGet cost reportgetUpdate cost reportputDelete cost reportdeleteGet cost report dataget
Cost-Reports
    List cost reportsgetCreate cost reportpostGet cost reportgetUpdate cost reportputDelete cost reportdeleteGet cost report dataget
Cost Data
    Get cost datagetGet cost forecastgetGet cost summaryget
Costs
    Get cost datagetGet cost forecastgetGet cost summaryget
Cost Alerts
    List cost alertsgetCreate cost alertpostGet cost alertgetUpdate cost alertputDelete cost alertdeleteGet cost alert eventsgetPause cost alertpostResume cost alertpost
Cost-Alerts
    List cost alertsgetCreate cost alertpostGet cost alertgetUpdate cost alertputDelete cost alertdeleteGet cost alert eventsgetPause cost alertpostResume cost alertpost
Contracting
    Get the data processing agreement statusget
Budgets
    List budgetsgetCreate budgetpostGet budgetgetUpdate budgetputDelete budgetdelete
Billing
    Get the account's entitlementgetGet the account's metered usageget
Entitlement
    Get the account's entitlementget
Usage
    Get the account's metered usageget
Anomalies
    Acknowledge anomalypostList anomaliesget
Allocation
    List allocation rulesgetCreate an allocation rulepostUpdate an allocation ruleputDelete an allocation ruledeleteReorder the allocation rule setpostRead allocation coveragegetList segmentsgetCreate a segmentpostUpdate a segmentputDelete a segmentdeletePreview an allocation rulepost
Segments
    List segmentsgetCreate a segmentpostUpdate a segmentputDelete a segmentdelete
Schemas
Costfluent Public API
Costfluent Public API

Workspaces

Server
Download schema

List workspaces

GET
https://api.costfluent.com
/v1/workspaces
Bearer (API token)

Returns all workspaces for the authenticated organization

List workspaces › query Parameters

page
​integer · int32 · required
limit
​integer · int32 · required

List workspaces › Responses

Success

CostfluentPublicApiModelsV1CommonPaginatedResponseOfWorkspaceResponse
​CostfluentPublicApiModelsV1CommonPaginationLinks · required
​CostfluentPublicApiModelsV1ResponsesWorkspaceResponse[] · required
GET/v1/workspaces
curl 'https://api.costfluent.com/v1/workspaces?page=<number>&limit=<number>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "links": { "self": "self", "first": "first", "prev": "prev", "next": "next", "last": "last" }, "data": [ { "id": { "Value": "Value" }, "name": "name", "currency": "currency", "enableCurrencyConversion": true, "providerCount": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" } ] }
json
application/json

Create workspace

POST
https://api.costfluent.com
/v1/workspaces
Bearer (API token)

Creates a new workspace for organizing cost data

Create workspace › Request Body

CostfluentPublicApiModelsV1RequestsCreateWorkspaceRequest
name
​string · minLength: 0 · maxLength: 200 · required
currency
​string · minLength: 3 · maxLength: 3 · required

Create workspace › Responses

Success

CostfluentPublicApiModelsV1ResponsesWorkspaceCreatedResponse
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
name
​string · required
POST/v1/workspaces
curl https://api.costfluent.com/v1/workspaces \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "name", "currency": "currency" }'
Example Request Body
{ "name": "name", "currency": "currency" }
json
Example Responses
{ "id": { "Value": "Value" }, "name": "name" }
json
application/json

Get workspace

GET
https://api.costfluent.com
/v1/workspaces/{workspaceId}
Bearer (API token)

Returns details of a specific workspace

Get workspace › path Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Get workspace › Responses

Success

CostfluentPublicApiModelsV1ResponsesWorkspaceResponse
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
name
​string · required
currency
​string · required
enableCurrencyConversion
​boolean
providerCount
​integer · int32
createdAt
​string · date-time
updatedAt
​string | null · date-time
GET/v1/workspaces/{workspaceId}
curl https://api.costfluent.com/v1/workspaces/:workspaceId \ --header 'Authorization: Bearer <token>'
Example Responses
{ "id": { "Value": "Value" }, "name": "name", "currency": "currency", "enableCurrencyConversion": true, "providerCount": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" }
json
application/json

Update workspace

PUT
https://api.costfluent.com
/v1/workspaces/{workspaceId}
Bearer (API token)

Updates workspace settings

Update workspace › path Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Update workspace › Request Body

CostfluentPublicApiModelsV1RequestsUpdateWorkspaceRequest
name
​string | null · minLength: 0 · maxLength: 200
currency
​string | null · minLength: 3 · maxLength: 3
enableCurrencyConversion
​boolean | null

Update workspace › Responses

Success

CostfluentPublicApiModelsV1ResponsesWorkspaceResponse
​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
name
​string · required
currency
​string · required
enableCurrencyConversion
​boolean
providerCount
​integer · int32
createdAt
​string · date-time
updatedAt
​string | null · date-time
PUT/v1/workspaces/{workspaceId}
curl https://api.costfluent.com/v1/workspaces/:workspaceId \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "name", "currency": "currency", "enableCurrencyConversion": true }'
Example Request Body
{ "name": "name", "currency": "currency", "enableCurrencyConversion": true }
json
Example Responses
{ "id": { "Value": "Value" }, "name": "name", "currency": "currency", "enableCurrencyConversion": true, "providerCount": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" }
json
application/json

Delete workspace

DELETE
https://api.costfluent.com
/v1/workspaces/{workspaceId}
Bearer (API token)

Deletes a workspace. Associated data may be retained.

Delete workspace › path Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Delete workspace › Responses

No Content

No data returned
DELETE/v1/workspaces/{workspaceId}
curl https://api.costfluent.com/v1/workspaces/:workspaceId \ --request DELETE \ --header 'Authorization: Bearer <token>'
Example Responses
No example specified for this content type

Get the workspace's exchange rate policy

GET
https://api.costfluent.com
/v1/workspaces/{workspaceId}/exchange-rates/policy
Bearer (API token)

The conversion method, the named rate source, and the period the policy applies to. Read-only: the policy is an accounting decision recorded with the account, not a setting.

Get the workspace's exchange rate policy › path Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Get the workspace's exchange rate policy › Responses

Success

CostfluentFeaturesExchangeRatesResponsesFxPolicyStatusResponse
available
​boolean · required
​required
​CostfluentFeaturesExchangeRatesResponsesFxPolicyResponse[] · required
GET/v1/workspaces/{workspaceId}/exchange-rates/policy
curl https://api.costfluent.com/v1/workspaces/:workspaceId/exchange-rates/policy \ --header 'Authorization: Bearer <token>'
Example Responses
{ "available": true, "current": { "token": { "Value": "Value" }, "method": "monthEndRate", "source": "source", "presentationCurrency": "presentationCurrency", "effectiveFrom": "2024-08-25", "effectiveToExclusive": "2024-08-25", "setAt": "2024-08-25T15:00:00Z", "isCurrent": true, "description": "description" }, "history": [ { "token": { "Value": "Value" }, "method": "monthEndRate", "source": "source", "presentationCurrency": "presentationCurrency", "effectiveFrom": "2024-08-25", "effectiveToExclusive": "2024-08-25", "setAt": "2024-08-25T15:00:00Z", "isCurrent": true, "description": "description" } ] }
json
application/json

Virtual Tags