Costfluent Docs
  • Pricing
  • Changelog
  • costfluent.com
  • Documentation
  • Guides
  • API Reference
Product
  • Pricing
  • Security
  • Changelog
Developers
  • API reference
  • Terraform
  • llms.txt
Legal
  • Privacy
  • Terms
  • Imprint
Information
Workspaces
    List workspacesgetCreate workspacepostGet workspacegetUpdate workspaceputDelete workspacedelete
Workspace Providers
    List workspace providersgetCreate workspace providerpostGet workspace providergetUpdate workspace providerputDelete workspace providerdelete
Virtual Tags
    List virtual tagsgetCreate virtual tagpostGet virtual taggetDelete virtual tagdeleteUpdate virtual tagpatch
Utility
    Get current token infogetHealth checkget
Tags
    Get tag keygetDelete tag keydeleteList tag keysget
Saved Filters
    List saved filtersgetCreate saved filterpostGet saved filtergetUpdate saved filterputDelete saved filterdelete
Providers
    List providersgetConnect providerpostGet providergetUpdate providerputDelete providerdeleteGet available providersgetGet the AWS connectorgetGet provider sync historygetProvision the GCP service accountpostTest provider connectionpostTrigger provider syncpost
Kubernetes
    Report Kubernetes usagepost
Folders
    List foldersgetCreate folderpostGet foldergetUpdate folderputDelete folderdelete
Exchange Rates
    Get available currenciesgetGet exchange rategetGet the workspace's exchange rate policygetList exchange ratesget
Dashboards
    List dashboardsgetCreate dashboardpostGet dashboardgetUpdate dashboardputDelete dashboarddelete
Custom Provider
    List uploadsgetUpload cost filespostGet uploadgetDelete uploaddeleteSubmit costs batchpost
Report Notifications
    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 Filters
    Translate a cost filterget
Cost Data
    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
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
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
Schemas
Costfluent Public API
Costfluent Public API

Workspace Providers

Download schema

List workspace providers

GET
https://api.costfluent.com
/v1/workspace-providers
Bearer (API token)

Returns the connections enabled in a workspace and the accounts it reads of each

List workspace providers › query Parameters

workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
page
​integer · int32 · required
limit
​integer · int32 · required

List workspace providers › Responses

Success

PaginatedResponseOfWorkspaceProviderResponse
​PaginationLinks · required
​WorkspaceProviderResponse[] · required
GET/v1/workspace-providers
curl 'https://api.costfluent.com/v1/workspace-providers?workspaceId=<string>&page=<number>&limit=<number>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "links": { "self": "self", "first": "first", "prev": "prev", "next": "next", "last": "last" }, "data": [ { "id": "id", "workspaceId": "workspaceId", "providerId": "providerId", "providerName": "providerName", "providerKey": "string", "isEnabled": true, "accountIds": [ "string" ], "addedAt": "2024-08-25T15:00:00Z" } ] }
json
application/json

Create workspace provider

POST
https://api.costfluent.com
/v1/workspace-providers
Bearer (API token)

Enables a connection in a workspace, for all its accounts or for the accounts listed. One connection can be enabled in several workspaces, each for its own accounts.

Create workspace provider › Request Body

CreateWorkspaceProviderRequest
workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · minLength: 1 · pattern: ^prv_[A-Za-z0-9_-]{2… · required
accountIds
​array | null

Create workspace provider › Responses

Created

WorkspaceProviderResponse
id
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required
workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
providerName
​string · required
accountIds
​string[] · required
​
isEnabled
​boolean
addedAt
​string · date-time
POST/v1/workspace-providers
curl https://api.costfluent.com/v1/workspace-providers \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "workspaceId": "workspaceId", "providerId": "providerId", "accountIds": [ "string" ] }'
Example Request Body
{ "workspaceId": "workspaceId", "providerId": "providerId", "accountIds": [ "string" ] }
json
Example Responses
{ "id": "id", "workspaceId": "workspaceId", "providerId": "providerId", "providerName": "providerName", "providerKey": "string", "isEnabled": true, "accountIds": [ "string" ], "addedAt": "2024-08-25T15:00:00Z" }
json
application/json

Get workspace provider

GET
https://api.costfluent.com
/v1/workspace-providers/{workspaceProviderId}
Bearer (API token)

Returns one connection enabled in a workspace and the accounts it reads

Get workspace provider › path Parameters

workspaceProviderId
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required

Get workspace provider › query Parameters

workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Get workspace provider › Responses

Success

WorkspaceProviderResponse
id
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required
workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
providerName
​string · required
accountIds
​string[] · required
​
isEnabled
​boolean
addedAt
​string · date-time
GET/v1/workspace-providers/{workspaceProviderId}
curl 'https://api.costfluent.com/v1/workspace-providers/:workspaceProviderId?workspaceId=<string>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "id": "id", "workspaceId": "workspaceId", "providerId": "providerId", "providerName": "providerName", "providerKey": "string", "isEnabled": true, "accountIds": [ "string" ], "addedAt": "2024-08-25T15:00:00Z" }
json
application/json

Update workspace provider

PUT
https://api.costfluent.com
/v1/workspace-providers/{workspaceProviderId}
Bearer (API token)

Turns a connection on or off in a workspace, or replaces the accounts it reads

Update workspace provider › path Parameters

workspaceProviderId
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required

Update workspace provider › Request Body

UpdateWorkspaceProviderRequest
workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
isEnabled
​boolean | null
accountIds
​array | null

Update workspace provider › Responses

Success

WorkspaceProviderResponse
id
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required
workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
providerId
​ProviderPublicId · pattern: ^prv_[A-Za-z0-9_-]{2… · required
providerName
​string · required
accountIds
​string[] · required
​
isEnabled
​boolean
addedAt
​string · date-time
PUT/v1/workspace-providers/{workspaceProviderId}
curl https://api.costfluent.com/v1/workspace-providers/:workspaceProviderId \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "workspaceId": "workspaceId", "isEnabled": true, "accountIds": [ "string" ] }'
Example Request Body
{ "workspaceId": "workspaceId", "isEnabled": true, "accountIds": [ "string" ] }
json
Example Responses
{ "id": "id", "workspaceId": "workspaceId", "providerId": "providerId", "providerName": "providerName", "providerKey": "string", "isEnabled": true, "accountIds": [ "string" ], "addedAt": "2024-08-25T15:00:00Z" }
json
application/json

Delete workspace provider

DELETE
https://api.costfluent.com
/v1/workspace-providers/{workspaceProviderId}
Bearer (API token)

Stops a workspace reading a connection. The connection and its cost stay; other workspaces that enable it are unaffected.

Delete workspace provider › path Parameters

workspaceProviderId
​WorkspaceProviderPublicId · pattern: ^wpr_[A-Za-z0-9_-]{2… · required

Delete workspace provider › query Parameters

workspaceId
​WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Delete workspace provider › Responses

No Content

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

WorkspacesVirtual Tags